mirror of https://github.com/portainer/portainer
feat(home): filter by connection type and agent version [EE-3373] (#7085)
parent
9666c21b8a
commit
5ee570e075
|
@ -0,0 +1,71 @@
|
||||||
|
package agent
|
||||||
|
|
||||||
|
import (
|
||||||
|
"crypto/tls"
|
||||||
|
"errors"
|
||||||
|
"fmt"
|
||||||
|
"net/http"
|
||||||
|
netUrl "net/url"
|
||||||
|
"strconv"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
portainer "github.com/portainer/portainer/api"
|
||||||
|
)
|
||||||
|
|
||||||
|
// GetAgentVersionAndPlatform returns the agent version and platform
|
||||||
|
//
|
||||||
|
// it sends a ping to the agent and parses the version and platform from the headers
|
||||||
|
func GetAgentVersionAndPlatform(url string, tlsConfig *tls.Config) (portainer.AgentPlatform, string, error) {
|
||||||
|
httpCli := &http.Client{
|
||||||
|
Timeout: 3 * time.Second,
|
||||||
|
}
|
||||||
|
|
||||||
|
if tlsConfig != nil {
|
||||||
|
httpCli.Transport = &http.Transport{
|
||||||
|
TLSClientConfig: tlsConfig,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
parsedURL, err := netUrl.Parse(fmt.Sprintf("%s/ping", url))
|
||||||
|
if err != nil {
|
||||||
|
return 0, "", err
|
||||||
|
}
|
||||||
|
|
||||||
|
parsedURL.Scheme = "https"
|
||||||
|
|
||||||
|
req, err := http.NewRequest(http.MethodGet, parsedURL.String(), nil)
|
||||||
|
if err != nil {
|
||||||
|
return 0, "", err
|
||||||
|
}
|
||||||
|
|
||||||
|
resp, err := httpCli.Do(req)
|
||||||
|
if err != nil {
|
||||||
|
return 0, "", err
|
||||||
|
}
|
||||||
|
defer resp.Body.Close()
|
||||||
|
|
||||||
|
if resp.StatusCode != http.StatusNoContent {
|
||||||
|
return 0, "", fmt.Errorf("Failed request with status %d", resp.StatusCode)
|
||||||
|
}
|
||||||
|
|
||||||
|
version := resp.Header.Get(portainer.PortainerAgentHeader)
|
||||||
|
if version == "" {
|
||||||
|
return 0, "", errors.New("Version Header is missing")
|
||||||
|
}
|
||||||
|
|
||||||
|
agentPlatformHeader := resp.Header.Get(portainer.HTTPResponseAgentPlatform)
|
||||||
|
if agentPlatformHeader == "" {
|
||||||
|
return 0, "", errors.New("Agent Platform Header is missing")
|
||||||
|
}
|
||||||
|
|
||||||
|
agentPlatformNumber, err := strconv.Atoi(agentPlatformHeader)
|
||||||
|
if err != nil {
|
||||||
|
return 0, "", err
|
||||||
|
}
|
||||||
|
|
||||||
|
if agentPlatformNumber == 0 {
|
||||||
|
return 0, "", errors.New("Agent platform is invalid")
|
||||||
|
}
|
||||||
|
|
||||||
|
return portainer.AgentPlatform(agentPlatformNumber), version, nil
|
||||||
|
}
|
|
@ -27,6 +27,9 @@
|
||||||
],
|
],
|
||||||
"endpoints": [
|
"endpoints": [
|
||||||
{
|
{
|
||||||
|
"Agent": {
|
||||||
|
"Version": ""
|
||||||
|
},
|
||||||
"AuthorizedTeams": null,
|
"AuthorizedTeams": null,
|
||||||
"AuthorizedUsers": null,
|
"AuthorizedUsers": null,
|
||||||
"AzureCredentials": {
|
"AzureCredentials": {
|
||||||
|
|
|
@ -85,6 +85,9 @@ func (handler *Handler) endpointEdgeStatusInspect(w http.ResponseWriter, r *http
|
||||||
endpoint.Type = agentPlatform
|
endpoint.Type = agentPlatform
|
||||||
}
|
}
|
||||||
|
|
||||||
|
version := r.Header.Get(portainer.PortainerAgentHeader)
|
||||||
|
endpoint.Agent.Version = version
|
||||||
|
|
||||||
endpoint.LastCheckInDate = time.Now().Unix()
|
endpoint.LastCheckInDate = time.Now().Unix()
|
||||||
|
|
||||||
err = handler.DataStore.Endpoint().UpdateEndpoint(endpoint.ID, endpoint)
|
err = handler.DataStore.Endpoint().UpdateEndpoint(endpoint.ID, endpoint)
|
||||||
|
|
|
@ -0,0 +1,50 @@
|
||||||
|
package endpoints
|
||||||
|
|
||||||
|
import (
|
||||||
|
"net/http"
|
||||||
|
|
||||||
|
httperror "github.com/portainer/libhttp/error"
|
||||||
|
"github.com/portainer/libhttp/response"
|
||||||
|
"github.com/portainer/portainer/api/http/security"
|
||||||
|
"github.com/portainer/portainer/api/internal/set"
|
||||||
|
)
|
||||||
|
|
||||||
|
// @id AgentVersions
|
||||||
|
// @summary List agent versions
|
||||||
|
// @description List all agent versions based on the current user authorizations and query parameters.
|
||||||
|
// @description **Access policy**: restricted
|
||||||
|
// @tags endpoints
|
||||||
|
// @security ApiKeyAuth
|
||||||
|
// @security jwt
|
||||||
|
// @produce json
|
||||||
|
// @success 200 {array} string "List of available agent versions"
|
||||||
|
// @failure 500 "Server error"
|
||||||
|
// @router /endpoints/agent_versions [get]
|
||||||
|
|
||||||
|
func (handler *Handler) agentVersions(w http.ResponseWriter, r *http.Request) *httperror.HandlerError {
|
||||||
|
endpointGroups, err := handler.DataStore.EndpointGroup().EndpointGroups()
|
||||||
|
if err != nil {
|
||||||
|
return httperror.InternalServerError("Unable to retrieve environment groups from the database", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
endpoints, err := handler.DataStore.Endpoint().Endpoints()
|
||||||
|
if err != nil {
|
||||||
|
return httperror.InternalServerError("Unable to retrieve environments from the database", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
securityContext, err := security.RetrieveRestrictedRequestContext(r)
|
||||||
|
if err != nil {
|
||||||
|
return httperror.InternalServerError("Unable to retrieve info from request context", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
filteredEndpoints := security.FilterEndpoints(endpoints, endpointGroups, securityContext)
|
||||||
|
|
||||||
|
agentVersions := set.Set[string]{}
|
||||||
|
for _, endpoint := range filteredEndpoints {
|
||||||
|
if endpoint.Agent.Version != "" {
|
||||||
|
agentVersions[endpoint.Agent.Version] = true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return response.JSON(w, agentVersions.Keys())
|
||||||
|
}
|
|
@ -1,20 +1,19 @@
|
||||||
package endpoints
|
package endpoints
|
||||||
|
|
||||||
import (
|
import (
|
||||||
|
"crypto/tls"
|
||||||
"errors"
|
"errors"
|
||||||
"fmt"
|
|
||||||
"net/http"
|
"net/http"
|
||||||
"net/url"
|
|
||||||
"runtime"
|
"runtime"
|
||||||
"strconv"
|
"strconv"
|
||||||
"strings"
|
"strings"
|
||||||
"time"
|
|
||||||
|
|
||||||
"github.com/gofrs/uuid"
|
"github.com/gofrs/uuid"
|
||||||
httperror "github.com/portainer/libhttp/error"
|
httperror "github.com/portainer/libhttp/error"
|
||||||
"github.com/portainer/libhttp/request"
|
"github.com/portainer/libhttp/request"
|
||||||
"github.com/portainer/libhttp/response"
|
"github.com/portainer/libhttp/response"
|
||||||
portainer "github.com/portainer/portainer/api"
|
portainer "github.com/portainer/portainer/api"
|
||||||
|
"github.com/portainer/portainer/api/agent"
|
||||||
"github.com/portainer/portainer/api/crypto"
|
"github.com/portainer/portainer/api/crypto"
|
||||||
"github.com/portainer/portainer/api/http/client"
|
"github.com/portainer/portainer/api/http/client"
|
||||||
"github.com/portainer/portainer/api/internal/edge"
|
"github.com/portainer/portainer/api/internal/edge"
|
||||||
|
@ -245,6 +244,7 @@ func (handler *Handler) endpointCreate(w http.ResponseWriter, r *http.Request) *
|
||||||
}
|
}
|
||||||
|
|
||||||
func (handler *Handler) createEndpoint(payload *endpointCreatePayload) (*portainer.Endpoint, *httperror.HandlerError) {
|
func (handler *Handler) createEndpoint(payload *endpointCreatePayload) (*portainer.Endpoint, *httperror.HandlerError) {
|
||||||
|
var err error
|
||||||
switch payload.EndpointCreationType {
|
switch payload.EndpointCreationType {
|
||||||
case azureEnvironment:
|
case azureEnvironment:
|
||||||
return handler.createAzureEndpoint(payload)
|
return handler.createAzureEndpoint(payload)
|
||||||
|
@ -257,15 +257,25 @@ func (handler *Handler) createEndpoint(payload *endpointCreatePayload) (*portain
|
||||||
}
|
}
|
||||||
|
|
||||||
endpointType := portainer.DockerEnvironment
|
endpointType := portainer.DockerEnvironment
|
||||||
|
var agentVersion string
|
||||||
if payload.EndpointCreationType == agentEnvironment {
|
if payload.EndpointCreationType == agentEnvironment {
|
||||||
|
|
||||||
payload.URL = "tcp://" + normalizeAgentAddress(payload.URL)
|
payload.URL = "tcp://" + normalizeAgentAddress(payload.URL)
|
||||||
|
|
||||||
agentPlatform, err := handler.pingAndCheckPlatform(payload)
|
var tlsConfig *tls.Config
|
||||||
|
if payload.TLS {
|
||||||
|
tlsConfig, err = crypto.CreateTLSConfigurationFromBytes(payload.TLSCACertFile, payload.TLSCertFile, payload.TLSKeyFile, payload.TLSSkipVerify, payload.TLSSkipClientVerify)
|
||||||
|
if err != nil {
|
||||||
|
return nil, httperror.InternalServerError("Unable to create TLS configuration", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
agentPlatform, version, err := agent.GetAgentVersionAndPlatform(payload.URL, tlsConfig)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, &httperror.HandlerError{http.StatusInternalServerError, "Unable to get environment type", err}
|
return nil, &httperror.HandlerError{http.StatusInternalServerError, "Unable to get environment type", err}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
agentVersion = version
|
||||||
if agentPlatform == portainer.AgentPlatformDocker {
|
if agentPlatform == portainer.AgentPlatformDocker {
|
||||||
endpointType = portainer.AgentOnDockerEnvironment
|
endpointType = portainer.AgentOnDockerEnvironment
|
||||||
} else if agentPlatform == portainer.AgentPlatformKubernetes {
|
} else if agentPlatform == portainer.AgentPlatformKubernetes {
|
||||||
|
@ -275,7 +285,7 @@ func (handler *Handler) createEndpoint(payload *endpointCreatePayload) (*portain
|
||||||
}
|
}
|
||||||
|
|
||||||
if payload.TLS {
|
if payload.TLS {
|
||||||
return handler.createTLSSecuredEndpoint(payload, endpointType)
|
return handler.createTLSSecuredEndpoint(payload, endpointType, agentVersion)
|
||||||
}
|
}
|
||||||
return handler.createUnsecuredEndpoint(payload)
|
return handler.createUnsecuredEndpoint(payload)
|
||||||
}
|
}
|
||||||
|
@ -447,7 +457,7 @@ func (handler *Handler) createKubernetesEndpoint(payload *endpointCreatePayload)
|
||||||
return endpoint, nil
|
return endpoint, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
func (handler *Handler) createTLSSecuredEndpoint(payload *endpointCreatePayload, endpointType portainer.EndpointType) (*portainer.Endpoint, *httperror.HandlerError) {
|
func (handler *Handler) createTLSSecuredEndpoint(payload *endpointCreatePayload, endpointType portainer.EndpointType, agentVersion string) (*portainer.Endpoint, *httperror.HandlerError) {
|
||||||
endpointID := handler.DataStore.Endpoint().GetNextIdentifier()
|
endpointID := handler.DataStore.Endpoint().GetNextIdentifier()
|
||||||
endpoint := &portainer.Endpoint{
|
endpoint := &portainer.Endpoint{
|
||||||
ID: portainer.EndpointID(endpointID),
|
ID: portainer.EndpointID(endpointID),
|
||||||
|
@ -470,6 +480,8 @@ func (handler *Handler) createTLSSecuredEndpoint(payload *endpointCreatePayload,
|
||||||
IsEdgeDevice: payload.IsEdgeDevice,
|
IsEdgeDevice: payload.IsEdgeDevice,
|
||||||
}
|
}
|
||||||
|
|
||||||
|
endpoint.Agent.Version = agentVersion
|
||||||
|
|
||||||
err := handler.storeTLSFiles(endpoint, payload)
|
err := handler.storeTLSFiles(endpoint, payload)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, err
|
return nil, err
|
||||||
|
@ -563,58 +575,3 @@ func (handler *Handler) storeTLSFiles(endpoint *portainer.Endpoint, payload *end
|
||||||
|
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
func (handler *Handler) pingAndCheckPlatform(payload *endpointCreatePayload) (portainer.AgentPlatform, error) {
|
|
||||||
httpCli := &http.Client{
|
|
||||||
Timeout: 3 * time.Second,
|
|
||||||
}
|
|
||||||
|
|
||||||
if payload.TLS {
|
|
||||||
tlsConfig, err := crypto.CreateTLSConfigurationFromBytes(payload.TLSCACertFile, payload.TLSCertFile, payload.TLSKeyFile, payload.TLSSkipVerify, payload.TLSSkipClientVerify)
|
|
||||||
if err != nil {
|
|
||||||
return 0, err
|
|
||||||
}
|
|
||||||
|
|
||||||
httpCli.Transport = &http.Transport{
|
|
||||||
TLSClientConfig: tlsConfig,
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
url, err := url.Parse(fmt.Sprintf("%s/ping", payload.URL))
|
|
||||||
if err != nil {
|
|
||||||
return 0, err
|
|
||||||
}
|
|
||||||
|
|
||||||
url.Scheme = "https"
|
|
||||||
|
|
||||||
req, err := http.NewRequest(http.MethodGet, url.String(), nil)
|
|
||||||
if err != nil {
|
|
||||||
return 0, err
|
|
||||||
}
|
|
||||||
|
|
||||||
resp, err := httpCli.Do(req)
|
|
||||||
if err != nil {
|
|
||||||
return 0, err
|
|
||||||
}
|
|
||||||
defer resp.Body.Close()
|
|
||||||
|
|
||||||
if resp.StatusCode != http.StatusNoContent {
|
|
||||||
return 0, fmt.Errorf("Failed request with status %d", resp.StatusCode)
|
|
||||||
}
|
|
||||||
|
|
||||||
agentPlatformHeader := resp.Header.Get(portainer.HTTPResponseAgentPlatform)
|
|
||||||
if agentPlatformHeader == "" {
|
|
||||||
return 0, errors.New("Agent Platform Header is missing")
|
|
||||||
}
|
|
||||||
|
|
||||||
agentPlatformNumber, err := strconv.Atoi(agentPlatformHeader)
|
|
||||||
if err != nil {
|
|
||||||
return 0, err
|
|
||||||
}
|
|
||||||
|
|
||||||
if agentPlatformNumber == 0 {
|
|
||||||
return 0, errors.New("Agent platform is invalid")
|
|
||||||
}
|
|
||||||
|
|
||||||
return portainer.AgentPlatform(agentPlatformNumber), nil
|
|
||||||
}
|
|
||||||
|
|
|
@ -41,6 +41,7 @@ const (
|
||||||
// @param tagsPartialMatch query bool false "If true, will return environment(endpoint) which has one of tagIds, if false (or missing) will return only environments(endpoints) that has all the tags"
|
// @param tagsPartialMatch query bool false "If true, will return environment(endpoint) which has one of tagIds, if false (or missing) will return only environments(endpoints) that has all the tags"
|
||||||
// @param endpointIds query []int false "will return only these environments(endpoints)"
|
// @param endpointIds query []int false "will return only these environments(endpoints)"
|
||||||
// @param provisioned query bool false "If true, will return environment(endpoint) that were provisioned"
|
// @param provisioned query bool false "If true, will return environment(endpoint) that were provisioned"
|
||||||
|
// @param agentVersions query []string false "will return only environments with on of these agent versions"
|
||||||
// @param edgeDevice query bool false "if exists true show only edge devices, false show only regular edge endpoints. if missing, will show both types (relevant only for edge endpoints)"
|
// @param edgeDevice query bool false "if exists true show only edge devices, false show only regular edge endpoints. if missing, will show both types (relevant only for edge endpoints)"
|
||||||
// @param edgeDeviceUntrusted query bool false "if true, show only untrusted endpoints, if false show only trusted (relevant only for edge devices, and if edgeDevice is true)"
|
// @param edgeDeviceUntrusted query bool false "if true, show only untrusted endpoints, if false show only trusted (relevant only for edge devices, and if edgeDevice is true)"
|
||||||
// @param name query string false "will return only environments(endpoints) with this name"
|
// @param name query string false "will return only environments(endpoints) with this name"
|
||||||
|
|
|
@ -21,6 +21,89 @@ type endpointListTest struct {
|
||||||
expected []portainer.EndpointID
|
expected []portainer.EndpointID
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func Test_EndpointList_AgentVersion(t *testing.T) {
|
||||||
|
|
||||||
|
version1Endpoint := portainer.Endpoint{
|
||||||
|
ID: 1,
|
||||||
|
GroupID: 1,
|
||||||
|
Type: portainer.AgentOnDockerEnvironment,
|
||||||
|
Agent: struct {
|
||||||
|
Version string "example:\"1.0.0\""
|
||||||
|
}{
|
||||||
|
Version: "1.0.0",
|
||||||
|
},
|
||||||
|
}
|
||||||
|
version2Endpoint := portainer.Endpoint{ID: 2, GroupID: 1, Type: portainer.AgentOnDockerEnvironment, Agent: struct {
|
||||||
|
Version string "example:\"1.0.0\""
|
||||||
|
}{Version: "2.0.0"}}
|
||||||
|
noVersionEndpoint := portainer.Endpoint{ID: 3, Type: portainer.AgentOnDockerEnvironment, GroupID: 1}
|
||||||
|
notAgentEnvironments := portainer.Endpoint{ID: 4, Type: portainer.DockerEnvironment, GroupID: 1}
|
||||||
|
|
||||||
|
handler, teardown := setup(t, []portainer.Endpoint{
|
||||||
|
notAgentEnvironments,
|
||||||
|
version1Endpoint,
|
||||||
|
version2Endpoint,
|
||||||
|
noVersionEndpoint,
|
||||||
|
})
|
||||||
|
|
||||||
|
defer teardown()
|
||||||
|
|
||||||
|
type endpointListAgentVersionTest struct {
|
||||||
|
endpointListTest
|
||||||
|
filter []string
|
||||||
|
}
|
||||||
|
|
||||||
|
tests := []endpointListAgentVersionTest{
|
||||||
|
{
|
||||||
|
endpointListTest{
|
||||||
|
"should show version 1 agent endpoints and non-agent endpoints",
|
||||||
|
[]portainer.EndpointID{version1Endpoint.ID, notAgentEnvironments.ID},
|
||||||
|
},
|
||||||
|
[]string{version1Endpoint.Agent.Version},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
endpointListTest{
|
||||||
|
"should show version 2 endpoints and non-agent endpoints",
|
||||||
|
[]portainer.EndpointID{version2Endpoint.ID, notAgentEnvironments.ID},
|
||||||
|
},
|
||||||
|
[]string{version2Endpoint.Agent.Version},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
endpointListTest{
|
||||||
|
"should show version 1 and 2 endpoints and non-agent endpoints",
|
||||||
|
[]portainer.EndpointID{version2Endpoint.ID, notAgentEnvironments.ID, version1Endpoint.ID},
|
||||||
|
},
|
||||||
|
[]string{version2Endpoint.Agent.Version, version1Endpoint.Agent.Version},
|
||||||
|
},
|
||||||
|
}
|
||||||
|
|
||||||
|
for _, test := range tests {
|
||||||
|
t.Run(test.title, func(t *testing.T) {
|
||||||
|
is := assert.New(t)
|
||||||
|
query := ""
|
||||||
|
for _, filter := range test.filter {
|
||||||
|
query += fmt.Sprintf("agentVersions[]=%s&", filter)
|
||||||
|
}
|
||||||
|
|
||||||
|
req := buildEndpointListRequest(query)
|
||||||
|
|
||||||
|
resp, err := doEndpointListRequest(req, handler, is)
|
||||||
|
is.NoError(err)
|
||||||
|
|
||||||
|
is.Equal(len(test.expected), len(resp))
|
||||||
|
|
||||||
|
respIds := []portainer.EndpointID{}
|
||||||
|
|
||||||
|
for _, endpoint := range resp {
|
||||||
|
respIds = append(respIds, endpoint.ID)
|
||||||
|
}
|
||||||
|
|
||||||
|
is.ElementsMatch(test.expected, respIds)
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
||||||
|
|
||||||
func Test_endpointList_edgeDeviceFilter(t *testing.T) {
|
func Test_endpointList_edgeDeviceFilter(t *testing.T) {
|
||||||
|
|
||||||
trustedEdgeDevice := portainer.Endpoint{ID: 1, UserTrusted: true, IsEdgeDevice: true, GroupID: 1, Type: portainer.EdgeAgentOnDockerEnvironment}
|
trustedEdgeDevice := portainer.Endpoint{ID: 1, UserTrusted: true, IsEdgeDevice: true, GroupID: 1, Type: portainer.EdgeAgentOnDockerEnvironment}
|
||||||
|
@ -48,7 +131,7 @@ func Test_endpointList_edgeDeviceFilter(t *testing.T) {
|
||||||
tests := []endpointListEdgeDeviceTest{
|
tests := []endpointListEdgeDeviceTest{
|
||||||
{
|
{
|
||||||
endpointListTest: endpointListTest{
|
endpointListTest: endpointListTest{
|
||||||
"should show all endpoints expect of the untrusted devices",
|
"should show all endpoints except of the untrusted devices",
|
||||||
[]portainer.EndpointID{trustedEdgeDevice.ID, regularUntrustedEdgeEndpoint.ID, regularTrustedEdgeEndpoint.ID, regularEndpoint.ID},
|
[]portainer.EndpointID{trustedEdgeDevice.ID, regularUntrustedEdgeEndpoint.ID, regularTrustedEdgeEndpoint.ID, regularEndpoint.ID},
|
||||||
},
|
},
|
||||||
edgeDevice: nil,
|
edgeDevice: nil,
|
||||||
|
|
|
@ -55,6 +55,7 @@ func (handler *Handler) endpointSnapshot(w http.ResponseWriter, r *http.Request)
|
||||||
|
|
||||||
latestEndpointReference.Snapshots = endpoint.Snapshots
|
latestEndpointReference.Snapshots = endpoint.Snapshots
|
||||||
latestEndpointReference.Kubernetes.Snapshots = endpoint.Kubernetes.Snapshots
|
latestEndpointReference.Kubernetes.Snapshots = endpoint.Kubernetes.Snapshots
|
||||||
|
latestEndpointReference.Agent.Version = endpoint.Agent.Version
|
||||||
|
|
||||||
err = handler.DataStore.Endpoint().UpdateEndpoint(latestEndpointReference.ID, latestEndpointReference)
|
err = handler.DataStore.Endpoint().UpdateEndpoint(latestEndpointReference.ID, latestEndpointReference)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
|
|
|
@ -47,6 +47,7 @@ func (handler *Handler) endpointSnapshots(w http.ResponseWriter, r *http.Request
|
||||||
|
|
||||||
latestEndpointReference.Snapshots = endpoint.Snapshots
|
latestEndpointReference.Snapshots = endpoint.Snapshots
|
||||||
latestEndpointReference.Kubernetes.Snapshots = endpoint.Kubernetes.Snapshots
|
latestEndpointReference.Kubernetes.Snapshots = endpoint.Kubernetes.Snapshots
|
||||||
|
latestEndpointReference.Agent.Version = endpoint.Agent.Version
|
||||||
|
|
||||||
err = handler.DataStore.Endpoint().UpdateEndpoint(latestEndpointReference.ID, latestEndpointReference)
|
err = handler.DataStore.Endpoint().UpdateEndpoint(latestEndpointReference.ID, latestEndpointReference)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
|
|
|
@ -25,6 +25,7 @@ type EnvironmentsQuery struct {
|
||||||
edgeDevice *bool
|
edgeDevice *bool
|
||||||
edgeDeviceUntrusted bool
|
edgeDeviceUntrusted bool
|
||||||
name string
|
name string
|
||||||
|
agentVersions []string
|
||||||
}
|
}
|
||||||
|
|
||||||
func parseQuery(r *http.Request) (EnvironmentsQuery, error) {
|
func parseQuery(r *http.Request) (EnvironmentsQuery, error) {
|
||||||
|
@ -60,6 +61,8 @@ func parseQuery(r *http.Request) (EnvironmentsQuery, error) {
|
||||||
return EnvironmentsQuery{}, err
|
return EnvironmentsQuery{}, err
|
||||||
}
|
}
|
||||||
|
|
||||||
|
agentVersions := getArrayQueryParameter(r, "agentVersions")
|
||||||
|
|
||||||
name, _ := request.RetrieveQueryParameter(r, "name", true)
|
name, _ := request.RetrieveQueryParameter(r, "name", true)
|
||||||
|
|
||||||
edgeDeviceParam, _ := request.RetrieveQueryParameter(r, "edgeDevice", true)
|
edgeDeviceParam, _ := request.RetrieveQueryParameter(r, "edgeDevice", true)
|
||||||
|
@ -82,6 +85,7 @@ func parseQuery(r *http.Request) (EnvironmentsQuery, error) {
|
||||||
edgeDevice: edgeDevice,
|
edgeDevice: edgeDevice,
|
||||||
edgeDeviceUntrusted: edgeDeviceUntrusted,
|
edgeDeviceUntrusted: edgeDeviceUntrusted,
|
||||||
name: name,
|
name: name,
|
||||||
|
agentVersions: agentVersions,
|
||||||
}, nil
|
}, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@ -135,6 +139,12 @@ func (handler *Handler) filterEndpointsByQuery(filteredEndpoints []portainer.End
|
||||||
filteredEndpoints = filteredEndpointsByTags(filteredEndpoints, query.tagIds, groups, query.tagsPartialMatch)
|
filteredEndpoints = filteredEndpointsByTags(filteredEndpoints, query.tagIds, groups, query.tagsPartialMatch)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
if len(query.agentVersions) > 0 {
|
||||||
|
filteredEndpoints = filter(filteredEndpoints, func(endpoint portainer.Endpoint) bool {
|
||||||
|
return !endpointutils.IsAgentEndpoint(&endpoint) || contains(query.agentVersions, endpoint.Agent.Version)
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
return filteredEndpoints, totalAvailableEndpoints, nil
|
return filteredEndpoints, totalAvailableEndpoints, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@ -413,3 +423,13 @@ func getNumberArrayQueryParameter[T ~int](r *http.Request, parameter string) ([]
|
||||||
|
|
||||||
return result, nil
|
return result, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func contains(strings []string, param string) bool {
|
||||||
|
for _, str := range strings {
|
||||||
|
if str == param {
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
|
|
@ -16,6 +16,64 @@ type filterTest struct {
|
||||||
query EnvironmentsQuery
|
query EnvironmentsQuery
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func Test_Filter_AgentVersion(t *testing.T) {
|
||||||
|
|
||||||
|
version1Endpoint := portainer.Endpoint{ID: 1, GroupID: 1,
|
||||||
|
Type: portainer.AgentOnDockerEnvironment,
|
||||||
|
Agent: struct {
|
||||||
|
Version string "example:\"1.0.0\""
|
||||||
|
}{Version: "1.0.0"}}
|
||||||
|
version2Endpoint := portainer.Endpoint{ID: 2, GroupID: 1,
|
||||||
|
Type: portainer.AgentOnDockerEnvironment,
|
||||||
|
Agent: struct {
|
||||||
|
Version string "example:\"1.0.0\""
|
||||||
|
}{Version: "2.0.0"}}
|
||||||
|
noVersionEndpoint := portainer.Endpoint{ID: 3, GroupID: 1,
|
||||||
|
Type: portainer.AgentOnDockerEnvironment,
|
||||||
|
}
|
||||||
|
notAgentEnvironments := portainer.Endpoint{ID: 4, Type: portainer.DockerEnvironment, GroupID: 1}
|
||||||
|
|
||||||
|
endpoints := []portainer.Endpoint{
|
||||||
|
version1Endpoint,
|
||||||
|
version2Endpoint,
|
||||||
|
noVersionEndpoint,
|
||||||
|
notAgentEnvironments,
|
||||||
|
}
|
||||||
|
|
||||||
|
handler, teardown := setupFilterTest(t, endpoints)
|
||||||
|
|
||||||
|
defer teardown()
|
||||||
|
|
||||||
|
tests := []filterTest{
|
||||||
|
{
|
||||||
|
"should show version 1 endpoints",
|
||||||
|
[]portainer.EndpointID{version1Endpoint.ID},
|
||||||
|
EnvironmentsQuery{
|
||||||
|
agentVersions: []string{version1Endpoint.Agent.Version},
|
||||||
|
types: []portainer.EndpointType{portainer.AgentOnDockerEnvironment},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"should show version 2 endpoints",
|
||||||
|
[]portainer.EndpointID{version2Endpoint.ID},
|
||||||
|
EnvironmentsQuery{
|
||||||
|
agentVersions: []string{version2Endpoint.Agent.Version},
|
||||||
|
types: []portainer.EndpointType{portainer.AgentOnDockerEnvironment},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"should show version 1 and 2 endpoints",
|
||||||
|
[]portainer.EndpointID{version2Endpoint.ID, version1Endpoint.ID},
|
||||||
|
EnvironmentsQuery{
|
||||||
|
agentVersions: []string{version2Endpoint.Agent.Version, version1Endpoint.Agent.Version},
|
||||||
|
types: []portainer.EndpointType{portainer.AgentOnDockerEnvironment},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
}
|
||||||
|
|
||||||
|
runTests(tests, t, handler, endpoints)
|
||||||
|
}
|
||||||
|
|
||||||
func Test_Filter_edgeDeviceFilter(t *testing.T) {
|
func Test_Filter_edgeDeviceFilter(t *testing.T) {
|
||||||
|
|
||||||
trustedEdgeDevice := portainer.Endpoint{ID: 1, UserTrusted: true, IsEdgeDevice: true, GroupID: 1, Type: portainer.EdgeAgentOnDockerEnvironment}
|
trustedEdgeDevice := portainer.Endpoint{ID: 1, UserTrusted: true, IsEdgeDevice: true, GroupID: 1, Type: portainer.EdgeAgentOnDockerEnvironment}
|
||||||
|
|
|
@ -67,6 +67,9 @@ func NewHandler(bouncer requestBouncer, demoService *demo.Service) *Handler {
|
||||||
bouncer.AdminAccess(httperror.LoggerHandler(h.endpointSnapshots))).Methods(http.MethodPost)
|
bouncer.AdminAccess(httperror.LoggerHandler(h.endpointSnapshots))).Methods(http.MethodPost)
|
||||||
h.Handle("/endpoints",
|
h.Handle("/endpoints",
|
||||||
bouncer.RestrictedAccess(httperror.LoggerHandler(h.endpointList))).Methods(http.MethodGet)
|
bouncer.RestrictedAccess(httperror.LoggerHandler(h.endpointList))).Methods(http.MethodGet)
|
||||||
|
h.Handle("/endpoints/agent_versions",
|
||||||
|
bouncer.RestrictedAccess(httperror.LoggerHandler(h.agentVersions))).Methods(http.MethodGet)
|
||||||
|
|
||||||
h.Handle("/endpoints/{id}",
|
h.Handle("/endpoints/{id}",
|
||||||
bouncer.RestrictedAccess(httperror.LoggerHandler(h.endpointInspect))).Methods(http.MethodGet)
|
bouncer.RestrictedAccess(httperror.LoggerHandler(h.endpointInspect))).Methods(http.MethodGet)
|
||||||
h.Handle("/endpoints/{id}",
|
h.Handle("/endpoints/{id}",
|
||||||
|
|
|
@ -0,0 +1,40 @@
|
||||||
|
package set
|
||||||
|
|
||||||
|
type SetKey interface {
|
||||||
|
~int | ~string
|
||||||
|
}
|
||||||
|
|
||||||
|
type Set[T SetKey] map[T]bool
|
||||||
|
|
||||||
|
func (s Set[T]) Add(key T) {
|
||||||
|
s[key] = true
|
||||||
|
}
|
||||||
|
|
||||||
|
func (s Set[T]) Contains(key T) bool {
|
||||||
|
_, ok := s[key]
|
||||||
|
return ok
|
||||||
|
}
|
||||||
|
|
||||||
|
func (s Set[T]) Remove(key T) {
|
||||||
|
delete(s, key)
|
||||||
|
}
|
||||||
|
|
||||||
|
func (s Set[T]) Len() int {
|
||||||
|
return len(s)
|
||||||
|
}
|
||||||
|
|
||||||
|
func (s Set[T]) IsEmpty() bool {
|
||||||
|
return len(s) == 0
|
||||||
|
}
|
||||||
|
|
||||||
|
func (s Set[T]) Keys() []T {
|
||||||
|
keys := make([]T, s.Len())
|
||||||
|
|
||||||
|
i := 0
|
||||||
|
for k := range s {
|
||||||
|
keys[i] = k
|
||||||
|
i++
|
||||||
|
}
|
||||||
|
|
||||||
|
return keys
|
||||||
|
}
|
|
@ -2,11 +2,14 @@ package snapshot
|
||||||
|
|
||||||
import (
|
import (
|
||||||
"context"
|
"context"
|
||||||
|
"crypto/tls"
|
||||||
"errors"
|
"errors"
|
||||||
"log"
|
"log"
|
||||||
"time"
|
"time"
|
||||||
|
|
||||||
portainer "github.com/portainer/portainer/api"
|
portainer "github.com/portainer/portainer/api"
|
||||||
|
"github.com/portainer/portainer/api/agent"
|
||||||
|
"github.com/portainer/portainer/api/crypto"
|
||||||
"github.com/portainer/portainer/api/dataservices"
|
"github.com/portainer/portainer/api/dataservices"
|
||||||
)
|
)
|
||||||
|
|
||||||
|
@ -87,6 +90,24 @@ func SupportDirectSnapshot(endpoint *portainer.Endpoint) bool {
|
||||||
// SnapshotEndpoint will create a snapshot of the environment(endpoint) based on the environment(endpoint) type.
|
// SnapshotEndpoint will create a snapshot of the environment(endpoint) based on the environment(endpoint) type.
|
||||||
// If the snapshot is a success, it will be associated to the environment(endpoint).
|
// If the snapshot is a success, it will be associated to the environment(endpoint).
|
||||||
func (service *Service) SnapshotEndpoint(endpoint *portainer.Endpoint) error {
|
func (service *Service) SnapshotEndpoint(endpoint *portainer.Endpoint) error {
|
||||||
|
if endpoint.Type == portainer.AgentOnDockerEnvironment || endpoint.Type == portainer.AgentOnKubernetesEnvironment {
|
||||||
|
var err error
|
||||||
|
var tlsConfig *tls.Config
|
||||||
|
if endpoint.TLSConfig.TLS {
|
||||||
|
tlsConfig, err = crypto.CreateTLSConfigurationFromDisk(endpoint.TLSConfig.TLSCACertPath, endpoint.TLSConfig.TLSCertPath, endpoint.TLSConfig.TLSKeyPath, endpoint.TLSConfig.TLSSkipVerify)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
_, version, err := agent.GetAgentVersionAndPlatform(endpoint.URL, tlsConfig)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
endpoint.Agent.Version = version
|
||||||
|
}
|
||||||
|
|
||||||
switch endpoint.Type {
|
switch endpoint.Type {
|
||||||
case portainer.AzureEnvironment:
|
case portainer.AzureEnvironment:
|
||||||
return nil
|
return nil
|
||||||
|
@ -175,6 +196,7 @@ func (service *Service) snapshotEndpoints() error {
|
||||||
|
|
||||||
latestEndpointReference.Snapshots = endpoint.Snapshots
|
latestEndpointReference.Snapshots = endpoint.Snapshots
|
||||||
latestEndpointReference.Kubernetes.Snapshots = endpoint.Kubernetes.Snapshots
|
latestEndpointReference.Kubernetes.Snapshots = endpoint.Kubernetes.Snapshots
|
||||||
|
latestEndpointReference.Agent.Version = endpoint.Agent.Version
|
||||||
|
|
||||||
err = service.dataStore.Endpoint().UpdateEndpoint(latestEndpointReference.ID, latestEndpointReference)
|
err = service.dataStore.Endpoint().UpdateEndpoint(latestEndpointReference.ID, latestEndpointReference)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
|
|
|
@ -359,6 +359,10 @@ type (
|
||||||
CommandInterval int `json:"CommandInterval" example:"60"`
|
CommandInterval int `json:"CommandInterval" example:"60"`
|
||||||
}
|
}
|
||||||
|
|
||||||
|
Agent struct {
|
||||||
|
Version string `example:"1.0.0"`
|
||||||
|
}
|
||||||
|
|
||||||
// Deprecated fields
|
// Deprecated fields
|
||||||
// Deprecated in DBVersion == 4
|
// Deprecated in DBVersion == 4
|
||||||
TLS bool `json:"TLS,omitempty"`
|
TLS bool `json:"TLS,omitempty"`
|
||||||
|
|
|
@ -166,6 +166,7 @@ interface CreateEdgeAgentEnvironment {
|
||||||
meta?: EnvironmentMetadata;
|
meta?: EnvironmentMetadata;
|
||||||
pollFrequency: number;
|
pollFrequency: number;
|
||||||
gpus?: Gpu[];
|
gpus?: Gpu[];
|
||||||
|
isEdgeDevice?: boolean;
|
||||||
}
|
}
|
||||||
|
|
||||||
export function createEdgeAgentEnvironment({
|
export function createEdgeAgentEnvironment({
|
||||||
|
@ -173,18 +174,20 @@ export function createEdgeAgentEnvironment({
|
||||||
portainerUrl,
|
portainerUrl,
|
||||||
meta = { tagIds: [] },
|
meta = { tagIds: [] },
|
||||||
gpus = [],
|
gpus = [],
|
||||||
|
isEdgeDevice,
|
||||||
}: CreateEdgeAgentEnvironment) {
|
}: CreateEdgeAgentEnvironment) {
|
||||||
return createEnvironment(
|
return createEnvironment(
|
||||||
name,
|
name,
|
||||||
EnvironmentCreationTypes.EdgeAgentEnvironment,
|
EnvironmentCreationTypes.EdgeAgentEnvironment,
|
||||||
{
|
{
|
||||||
url: portainerUrl,
|
url: portainerUrl,
|
||||||
...meta,
|
|
||||||
tls: {
|
tls: {
|
||||||
skipVerify: true,
|
skipVerify: true,
|
||||||
skipClientVerify: true,
|
skipClientVerify: true,
|
||||||
},
|
},
|
||||||
gpus,
|
gpus,
|
||||||
|
isEdgeDevice,
|
||||||
|
...meta,
|
||||||
}
|
}
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|
|
@ -26,6 +26,7 @@ export interface EnvironmentsQueryParams {
|
||||||
edgeDeviceUntrusted?: boolean;
|
edgeDeviceUntrusted?: boolean;
|
||||||
provisioned?: boolean;
|
provisioned?: boolean;
|
||||||
name?: string;
|
name?: string;
|
||||||
|
agentVersions?: string[];
|
||||||
}
|
}
|
||||||
|
|
||||||
export interface GetEnvironmentsOptions {
|
export interface GetEnvironmentsOptions {
|
||||||
|
@ -72,6 +73,17 @@ export async function getEnvironments(
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
export async function getAgentVersions() {
|
||||||
|
try {
|
||||||
|
const response = await axios.get<string[]>(
|
||||||
|
buildUrl(undefined, 'agent_versions')
|
||||||
|
);
|
||||||
|
return response.data;
|
||||||
|
} catch (e) {
|
||||||
|
throw parseAxiosError(e as Error);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
export async function getEndpoint(id: EnvironmentId) {
|
export async function getEndpoint(id: EnvironmentId) {
|
||||||
try {
|
try {
|
||||||
const { data: endpoint } = await axios.get<Environment>(buildUrl(id));
|
const { data: endpoint } = await axios.get<Environment>(buildUrl(id));
|
||||||
|
|
|
@ -0,0 +1,7 @@
|
||||||
|
import { useQuery } from 'react-query';
|
||||||
|
|
||||||
|
import { getAgentVersions } from '../environment.service';
|
||||||
|
|
||||||
|
export function useAgentVersionsList() {
|
||||||
|
return useQuery(['environments', 'agentVersions'], () => getAgentVersions());
|
||||||
|
}
|
|
@ -90,6 +90,7 @@ export interface EnvironmentSecuritySettings {
|
||||||
}
|
}
|
||||||
|
|
||||||
export type Environment = {
|
export type Environment = {
|
||||||
|
Agent: { Version: string };
|
||||||
Id: EnvironmentId;
|
Id: EnvironmentId;
|
||||||
Type: EnvironmentType;
|
Type: EnvironmentType;
|
||||||
TagIds: TagId[];
|
TagIds: TagId[];
|
||||||
|
@ -112,6 +113,7 @@ export type Environment = {
|
||||||
SecuritySettings: EnvironmentSecuritySettings;
|
SecuritySettings: EnvironmentSecuritySettings;
|
||||||
Gpus: { name: string; value: string }[];
|
Gpus: { name: string; value: string }[];
|
||||||
};
|
};
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* TS reference of endpoint_create.go#EndpointCreationType iota
|
* TS reference of endpoint_create.go#EndpointCreationType iota
|
||||||
*/
|
*/
|
||||||
|
|
|
@ -25,6 +25,15 @@ export function isKubernetesEnvironment(envType: EnvironmentType) {
|
||||||
return getPlatformType(envType) === PlatformType.Kubernetes;
|
return getPlatformType(envType) === PlatformType.Kubernetes;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
export function isAgentEnvironment(envType: EnvironmentType) {
|
||||||
|
return (
|
||||||
|
isEdgeEnvironment(envType) ||
|
||||||
|
[EnvironmentType.AgentOnDocker, EnvironmentType.AgentOnKubernetes].includes(
|
||||||
|
envType
|
||||||
|
)
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
export function isEdgeEnvironment(envType: EnvironmentType) {
|
export function isEdgeEnvironment(envType: EnvironmentType) {
|
||||||
return [
|
return [
|
||||||
EnvironmentType.EdgeAgentOnDocker,
|
EnvironmentType.EdgeAgentOnDocker,
|
||||||
|
|
|
@ -0,0 +1,29 @@
|
||||||
|
import { Zap } from 'react-feather';
|
||||||
|
|
||||||
|
import { EnvironmentType } from '@/portainer/environments/types';
|
||||||
|
import {
|
||||||
|
isAgentEnvironment,
|
||||||
|
isEdgeEnvironment,
|
||||||
|
} from '@/portainer/environments/utils';
|
||||||
|
|
||||||
|
interface Props {
|
||||||
|
type: EnvironmentType;
|
||||||
|
version: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
export function AgentVersionTag({ type, version }: Props) {
|
||||||
|
if (!isAgentEnvironment(type)) {
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
|
||||||
|
return (
|
||||||
|
<span className="space-x-1">
|
||||||
|
<span>
|
||||||
|
+ <Zap className="icon icon-xs vertical-center" aria-hidden="true" />
|
||||||
|
</span>
|
||||||
|
<span>{isEdgeEnvironment(type) ? 'Edge Agent' : 'Agent'}</span>
|
||||||
|
|
||||||
|
<span>{version}</span>
|
||||||
|
</span>
|
||||||
|
);
|
||||||
|
}
|
|
@ -15,6 +15,8 @@ export function EnvironmentStats({ environment }: Props) {
|
||||||
return (
|
return (
|
||||||
<EnvironmentStatsKubernetes
|
<EnvironmentStatsKubernetes
|
||||||
snapshots={environment.Kubernetes.Snapshots || []}
|
snapshots={environment.Kubernetes.Snapshots || []}
|
||||||
|
type={environment.Type}
|
||||||
|
agentVersion={environment.Agent.Version}
|
||||||
/>
|
/>
|
||||||
);
|
);
|
||||||
case PlatformType.Docker:
|
case PlatformType.Docker:
|
||||||
|
@ -22,6 +24,7 @@ export function EnvironmentStats({ environment }: Props) {
|
||||||
<EnvironmentStatsDocker
|
<EnvironmentStatsDocker
|
||||||
snapshots={environment.Snapshots}
|
snapshots={environment.Snapshots}
|
||||||
type={environment.Type}
|
type={environment.Type}
|
||||||
|
agentVersion={environment.Agent.Version}
|
||||||
/>
|
/>
|
||||||
);
|
);
|
||||||
default:
|
default:
|
||||||
|
|
|
@ -1,19 +1,23 @@
|
||||||
import { Zap } from 'react-feather';
|
|
||||||
|
|
||||||
import {
|
import {
|
||||||
DockerSnapshot,
|
DockerSnapshot,
|
||||||
EnvironmentType,
|
EnvironmentType,
|
||||||
} from '@/portainer/environments/types';
|
} from '@/portainer/environments/types';
|
||||||
import { addPlural } from '@/portainer/helpers/strings';
|
import { addPlural } from '@/portainer/helpers/strings';
|
||||||
|
|
||||||
|
import { AgentVersionTag } from './AgentVersionTag';
|
||||||
import { Stat } from './EnvironmentStatsItem';
|
import { Stat } from './EnvironmentStatsItem';
|
||||||
|
|
||||||
interface Props {
|
interface Props {
|
||||||
snapshots: DockerSnapshot[];
|
snapshots: DockerSnapshot[];
|
||||||
type: EnvironmentType;
|
type: EnvironmentType;
|
||||||
|
agentVersion: string;
|
||||||
}
|
}
|
||||||
|
|
||||||
export function EnvironmentStatsDocker({ snapshots = [], type }: Props) {
|
export function EnvironmentStatsDocker({
|
||||||
|
snapshots = [],
|
||||||
|
type,
|
||||||
|
agentVersion,
|
||||||
|
}: Props) {
|
||||||
if (snapshots.length === 0) {
|
if (snapshots.length === 0) {
|
||||||
return (
|
return (
|
||||||
<div className="blocklist-item-line endpoint-item">
|
<div className="blocklist-item-line endpoint-item">
|
||||||
|
@ -60,15 +64,9 @@ export function EnvironmentStatsDocker({ snapshots = [], type }: Props) {
|
||||||
</span>
|
</span>
|
||||||
|
|
||||||
<span className="small text-muted space-x-2 vertical-center">
|
<span className="small text-muted space-x-2 vertical-center">
|
||||||
<span>{snapshot.Swarm ? 'Swarm' : 'Standalone'}</span>
|
|
||||||
<span>{snapshot.DockerVersion}</span>
|
|
||||||
{type === EnvironmentType.AgentOnDocker && (
|
|
||||||
<span>
|
<span>
|
||||||
+{' '}
|
{snapshot.Swarm ? 'Swarm' : 'Standalone'} {snapshot.DockerVersion}
|
||||||
<Zap className="icon icon-xs vertical-center" aria-hidden="true" />{' '}
|
|
||||||
Agent
|
|
||||||
</span>
|
</span>
|
||||||
)}
|
|
||||||
{snapshot.Swarm && (
|
{snapshot.Swarm && (
|
||||||
<Stat
|
<Stat
|
||||||
value={addPlural(snapshot.NodeCount, 'node')}
|
value={addPlural(snapshot.NodeCount, 'node')}
|
||||||
|
@ -76,6 +74,7 @@ export function EnvironmentStatsDocker({ snapshots = [], type }: Props) {
|
||||||
featherIcon
|
featherIcon
|
||||||
/>
|
/>
|
||||||
)}
|
)}
|
||||||
|
<AgentVersionTag version={agentVersion} type={type} />
|
||||||
</span>
|
</span>
|
||||||
</div>
|
</div>
|
||||||
);
|
);
|
||||||
|
|
|
@ -1,14 +1,24 @@
|
||||||
import { KubernetesSnapshot } from '@/portainer/environments/types';
|
import {
|
||||||
|
EnvironmentType,
|
||||||
|
KubernetesSnapshot,
|
||||||
|
} from '@/portainer/environments/types';
|
||||||
import { humanize } from '@/portainer/filters/filters';
|
import { humanize } from '@/portainer/filters/filters';
|
||||||
import { addPlural } from '@/portainer/helpers/strings';
|
import { addPlural } from '@/portainer/helpers/strings';
|
||||||
|
|
||||||
|
import { AgentVersionTag } from './AgentVersionTag';
|
||||||
import { Stat } from './EnvironmentStatsItem';
|
import { Stat } from './EnvironmentStatsItem';
|
||||||
|
|
||||||
interface Props {
|
interface Props {
|
||||||
snapshots?: KubernetesSnapshot[];
|
snapshots?: KubernetesSnapshot[];
|
||||||
|
type: EnvironmentType;
|
||||||
|
agentVersion: string;
|
||||||
}
|
}
|
||||||
|
|
||||||
export function EnvironmentStatsKubernetes({ snapshots = [] }: Props) {
|
export function EnvironmentStatsKubernetes({
|
||||||
|
snapshots = [],
|
||||||
|
type,
|
||||||
|
agentVersion,
|
||||||
|
}: Props) {
|
||||||
if (snapshots.length === 0) {
|
if (snapshots.length === 0) {
|
||||||
return (
|
return (
|
||||||
<div className="blocklist-item-line endpoint-item">
|
<div className="blocklist-item-line endpoint-item">
|
||||||
|
@ -38,6 +48,7 @@ export function EnvironmentStatsKubernetes({ snapshots = [] }: Props) {
|
||||||
icon="hard-drive"
|
icon="hard-drive"
|
||||||
featherIcon
|
featherIcon
|
||||||
/>
|
/>
|
||||||
|
<AgentVersionTag type={type} version={agentVersion} />
|
||||||
</span>
|
</span>
|
||||||
</div>
|
</div>
|
||||||
);
|
);
|
||||||
|
|
|
@ -1,12 +1,15 @@
|
||||||
import { ReactNode, useEffect, useState } from 'react';
|
import { ReactNode, useEffect, useState } from 'react';
|
||||||
import clsx from 'clsx';
|
import clsx from 'clsx';
|
||||||
import { RefreshCcw } from 'react-feather';
|
import { RefreshCcw } from 'react-feather';
|
||||||
|
import _ from 'lodash';
|
||||||
|
|
||||||
import { usePaginationLimitState } from '@/portainer/hooks/usePaginationLimitState';
|
import { usePaginationLimitState } from '@/portainer/hooks/usePaginationLimitState';
|
||||||
import {
|
import {
|
||||||
Environment,
|
Environment,
|
||||||
EnvironmentType,
|
EnvironmentType,
|
||||||
EnvironmentStatus,
|
EnvironmentStatus,
|
||||||
|
PlatformType,
|
||||||
|
EdgeTypes,
|
||||||
} from '@/portainer/environments/types';
|
} from '@/portainer/environments/types';
|
||||||
import { EnvironmentGroupId } from '@/portainer/environment-groups/types';
|
import { EnvironmentGroupId } from '@/portainer/environment-groups/types';
|
||||||
import { useIsAdmin } from '@/portainer/hooks/useUser';
|
import { useIsAdmin } from '@/portainer/hooks/useUser';
|
||||||
|
@ -22,6 +25,8 @@ import {
|
||||||
import { useGroups } from '@/portainer/environment-groups/queries';
|
import { useGroups } from '@/portainer/environment-groups/queries';
|
||||||
import { useTags } from '@/portainer/tags/queries';
|
import { useTags } from '@/portainer/tags/queries';
|
||||||
import { Filter } from '@/portainer/home/types';
|
import { Filter } from '@/portainer/home/types';
|
||||||
|
import { useAgentVersionsList } from '@/portainer/environments/queries/useAgentVersionsList';
|
||||||
|
import { EnvironmentsQueryParams } from '@/portainer/environments/environment.service';
|
||||||
|
|
||||||
import { TableFooter } from '@@/datatables/TableFooter';
|
import { TableFooter } from '@@/datatables/TableFooter';
|
||||||
import { TableActions, TableContainer, TableTitle } from '@@/datatables';
|
import { TableActions, TableContainer, TableTitle } from '@@/datatables';
|
||||||
|
@ -35,54 +40,49 @@ import { PaginationControls } from '@@/PaginationControls';
|
||||||
|
|
||||||
import { EnvironmentItem } from './EnvironmentItem';
|
import { EnvironmentItem } from './EnvironmentItem';
|
||||||
import { KubeconfigButton } from './KubeconfigButton';
|
import { KubeconfigButton } from './KubeconfigButton';
|
||||||
import styles from './EnvironmentList.module.css';
|
|
||||||
import { NoEnvironmentsInfoPanel } from './NoEnvironmentsInfoPanel';
|
import { NoEnvironmentsInfoPanel } from './NoEnvironmentsInfoPanel';
|
||||||
|
import styles from './EnvironmentList.module.css';
|
||||||
|
|
||||||
interface Props {
|
interface Props {
|
||||||
onClickItem(environment: Environment): void;
|
onClickItem(environment: Environment): void;
|
||||||
onRefresh(): void;
|
onRefresh(): void;
|
||||||
}
|
}
|
||||||
|
|
||||||
const PlatformOptions = [
|
|
||||||
{ value: EnvironmentType.Docker, label: 'Docker' },
|
|
||||||
{ value: EnvironmentType.Azure, label: 'Azure' },
|
|
||||||
{ value: EnvironmentType.KubernetesLocal, label: 'Kubernetes' },
|
|
||||||
];
|
|
||||||
|
|
||||||
const status = [
|
const status = [
|
||||||
{ value: EnvironmentStatus.Up, label: 'Up' },
|
{ value: EnvironmentStatus.Up, label: 'Up' },
|
||||||
{ value: EnvironmentStatus.Down, label: 'Down' },
|
{ value: EnvironmentStatus.Down, label: 'Down' },
|
||||||
];
|
];
|
||||||
|
|
||||||
const SortByOptions = [
|
const sortByOptions = [
|
||||||
{ value: 1, label: 'Name' },
|
{ value: 1, label: 'Name' },
|
||||||
{ value: 2, label: 'Group' },
|
{ value: 2, label: 'Group' },
|
||||||
{ value: 3, label: 'Status' },
|
{ value: 3, label: 'Status' },
|
||||||
];
|
];
|
||||||
|
|
||||||
|
enum ConnectionType {
|
||||||
|
API,
|
||||||
|
Agent,
|
||||||
|
EdgeAgent,
|
||||||
|
EdgeDevice,
|
||||||
|
}
|
||||||
|
|
||||||
const storageKey = 'home_endpoints';
|
const storageKey = 'home_endpoints';
|
||||||
const allEnvironmentType = [
|
|
||||||
EnvironmentType.Docker,
|
|
||||||
EnvironmentType.AgentOnDocker,
|
|
||||||
EnvironmentType.Azure,
|
|
||||||
EnvironmentType.EdgeAgentOnDocker,
|
|
||||||
EnvironmentType.KubernetesLocal,
|
|
||||||
EnvironmentType.AgentOnKubernetes,
|
|
||||||
EnvironmentType.EdgeAgentOnKubernetes,
|
|
||||||
];
|
|
||||||
|
|
||||||
export function EnvironmentList({ onClickItem, onRefresh }: Props) {
|
export function EnvironmentList({ onClickItem, onRefresh }: Props) {
|
||||||
const isAdmin = useIsAdmin();
|
const isAdmin = useIsAdmin();
|
||||||
|
|
||||||
const [platformType, setPlatformType] = useHomePageFilter(
|
const [platformTypes, setPlatformTypes] = useHomePageFilter<
|
||||||
'platformType',
|
Filter<PlatformType>[]
|
||||||
allEnvironmentType
|
>('platformType', []);
|
||||||
);
|
|
||||||
const [searchBarValue, setSearchBarValue] = useSearchBarState(storageKey);
|
const [searchBarValue, setSearchBarValue] = useSearchBarState(storageKey);
|
||||||
const [pageLimit, setPageLimit] = usePaginationLimitState(storageKey);
|
const [pageLimit, setPageLimit] = usePaginationLimitState(storageKey);
|
||||||
const [page, setPage] = useState(1);
|
const [page, setPage] = useState(1);
|
||||||
const debouncedTextFilter = useDebounce(searchBarValue);
|
const debouncedTextFilter = useDebounce(searchBarValue);
|
||||||
|
|
||||||
|
const [connectionTypes, setConnectionTypes] = useHomePageFilter<
|
||||||
|
Filter<ConnectionType>[]
|
||||||
|
>('connectionTypes', []);
|
||||||
|
|
||||||
const [statusFilter, setStatusFilter] = useHomePageFilter<
|
const [statusFilter, setStatusFilter] = useHomePageFilter<
|
||||||
EnvironmentStatus[]
|
EnvironmentStatus[]
|
||||||
>('status', []);
|
>('status', []);
|
||||||
|
@ -101,10 +101,6 @@ export function EnvironmentList({ onClickItem, onRefresh }: Props) {
|
||||||
false
|
false
|
||||||
);
|
);
|
||||||
|
|
||||||
const [platformState, setPlatformState] = useHomePageFilter<Filter[]>(
|
|
||||||
'type_state',
|
|
||||||
[]
|
|
||||||
);
|
|
||||||
const [statusState, setStatusState] = useHomePageFilter<Filter[]>(
|
const [statusState, setStatusState] = useHomePageFilter<Filter[]>(
|
||||||
'status_state',
|
'status_state',
|
||||||
[]
|
[]
|
||||||
|
@ -115,31 +111,46 @@ export function EnvironmentList({ onClickItem, onRefresh }: Props) {
|
||||||
[]
|
[]
|
||||||
);
|
);
|
||||||
const [sortByState, setSortByState] = useHomePageFilter<Filter | undefined>(
|
const [sortByState, setSortByState] = useHomePageFilter<Filter | undefined>(
|
||||||
'sortby_state',
|
'sort_by_state',
|
||||||
undefined
|
undefined
|
||||||
);
|
);
|
||||||
|
const [agentVersions, setAgentVersions] = useHomePageFilter<Filter<string>[]>(
|
||||||
|
'agentVersions',
|
||||||
|
[]
|
||||||
|
);
|
||||||
|
|
||||||
const groupsQuery = useGroups();
|
const groupsQuery = useGroups();
|
||||||
|
|
||||||
|
const environmentsQueryParams: EnvironmentsQueryParams = {
|
||||||
|
types: getTypes(
|
||||||
|
platformTypes.map((p) => p.value),
|
||||||
|
connectionTypes.map((p) => p.value)
|
||||||
|
),
|
||||||
|
search: debouncedTextFilter,
|
||||||
|
status: statusFilter,
|
||||||
|
tagIds: tagFilter?.length ? tagFilter : undefined,
|
||||||
|
groupIds: groupFilter,
|
||||||
|
edgeDevice: getEdgeDeviceFilter(connectionTypes.map((p) => p.value)),
|
||||||
|
tagsPartialMatch: true,
|
||||||
|
agentVersions: agentVersions.map((a) => a.value),
|
||||||
|
};
|
||||||
|
|
||||||
|
const tagsQuery = useTags();
|
||||||
|
|
||||||
const { isLoading, environments, totalCount, totalAvailable } =
|
const { isLoading, environments, totalCount, totalAvailable } =
|
||||||
useEnvironmentList(
|
useEnvironmentList(
|
||||||
{
|
{
|
||||||
page,
|
page,
|
||||||
pageLimit,
|
pageLimit,
|
||||||
types: platformType,
|
|
||||||
search: debouncedTextFilter,
|
|
||||||
status: statusFilter,
|
|
||||||
tagIds: tagFilter?.length ? tagFilter : undefined,
|
|
||||||
groupIds: groupFilter,
|
|
||||||
sort: sortByFilter,
|
sort: sortByFilter,
|
||||||
order: sortByDescending ? 'desc' : 'asc',
|
order: sortByDescending ? 'desc' : 'asc',
|
||||||
provisioned: true,
|
...environmentsQueryParams,
|
||||||
edgeDevice: false,
|
|
||||||
tagsPartialMatch: true,
|
|
||||||
},
|
},
|
||||||
refetchIfAnyOffline
|
refetchIfAnyOffline
|
||||||
);
|
);
|
||||||
|
|
||||||
|
const agentVersionsQuery = useAgentVersionsList();
|
||||||
|
|
||||||
useEffect(() => {
|
useEffect(() => {
|
||||||
setPage(1);
|
setPage(1);
|
||||||
}, [searchBarValue]);
|
}, [searchBarValue]);
|
||||||
|
@ -152,8 +163,7 @@ export function EnvironmentList({ onClickItem, onRefresh }: Props) {
|
||||||
label,
|
label,
|
||||||
}));
|
}));
|
||||||
|
|
||||||
const alltags = useTags();
|
const tagOptions = [...(tagsQuery.tags || [])];
|
||||||
const tagOptions = [...(alltags.tags || [])];
|
|
||||||
const uniqueTag = [
|
const uniqueTag = [
|
||||||
...new Map(tagOptions.map((item) => [item.ID, item])).values(),
|
...new Map(tagOptions.map((item) => [item.ID, item])).values(),
|
||||||
].map(({ ID: value, Name: label }) => ({
|
].map(({ ID: value, Name: label }) => ({
|
||||||
|
@ -161,39 +171,231 @@ export function EnvironmentList({ onClickItem, onRefresh }: Props) {
|
||||||
label,
|
label,
|
||||||
}));
|
}));
|
||||||
|
|
||||||
function platformOnChange(filterOptions: Filter[]) {
|
const connectionTypeOptions = getConnectionTypeOptions(platformTypes);
|
||||||
setPlatformState(filterOptions);
|
const platformTypeOptions = getPlatformTypeOptions(connectionTypes);
|
||||||
const dockerBaseType = EnvironmentType.Docker;
|
|
||||||
const kubernetesBaseType = EnvironmentType.KubernetesLocal;
|
return (
|
||||||
const dockerRelateType = [
|
<>
|
||||||
|
{totalAvailable === 0 && <NoEnvironmentsInfoPanel isAdmin={isAdmin} />}
|
||||||
|
<div className="row">
|
||||||
|
<div className="col-sm-12">
|
||||||
|
<TableContainer>
|
||||||
|
<TableTitle icon="hard-drive" featherIcon label="Environments" />
|
||||||
|
|
||||||
|
<TableActions className={styles.actionBar}>
|
||||||
|
<div className={styles.description}>
|
||||||
|
Click on an environment to manage
|
||||||
|
</div>
|
||||||
|
<div className={styles.actionButton}>
|
||||||
|
<div className={styles.refreshButton}>
|
||||||
|
{isAdmin && (
|
||||||
|
<Button
|
||||||
|
onClick={onRefresh}
|
||||||
|
data-cy="home-refreshEndpointsButton"
|
||||||
|
className={clsx(
|
||||||
|
'vertical-center',
|
||||||
|
styles.refreshEnvironmentsButton
|
||||||
|
)}
|
||||||
|
>
|
||||||
|
<RefreshCcw
|
||||||
|
className="feather icon-sm icon-white"
|
||||||
|
aria-hidden="true"
|
||||||
|
/>
|
||||||
|
Refresh
|
||||||
|
</Button>
|
||||||
|
)}
|
||||||
|
</div>
|
||||||
|
<div className={styles.kubeconfigButton}>
|
||||||
|
<KubeconfigButton
|
||||||
|
environments={environments}
|
||||||
|
envQueryParams={{
|
||||||
|
...environmentsQueryParams,
|
||||||
|
sort: sortByFilter,
|
||||||
|
order: sortByDescending ? 'desc' : 'asc',
|
||||||
|
}}
|
||||||
|
/>
|
||||||
|
</div>
|
||||||
|
<div className={styles.filterSearchbar}>
|
||||||
|
<FilterSearchBar
|
||||||
|
value={searchBarValue}
|
||||||
|
onChange={setSearchBarValue}
|
||||||
|
placeholder="Search by name, group, tag, status, URL..."
|
||||||
|
data-cy="home-endpointsSearchInput"
|
||||||
|
/>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</TableActions>
|
||||||
|
<div className={styles.filterContainer}>
|
||||||
|
<div className={styles.filterLeft}>
|
||||||
|
<HomepageFilter
|
||||||
|
filterOptions={platformTypeOptions}
|
||||||
|
onChange={setPlatformTypes}
|
||||||
|
placeHolder="Platform"
|
||||||
|
value={platformTypes}
|
||||||
|
/>
|
||||||
|
</div>
|
||||||
|
<div className={styles.filterLeft}>
|
||||||
|
<HomepageFilter
|
||||||
|
filterOptions={connectionTypeOptions}
|
||||||
|
onChange={setConnectionTypes}
|
||||||
|
placeHolder="Connection Type"
|
||||||
|
value={connectionTypes}
|
||||||
|
/>
|
||||||
|
</div>
|
||||||
|
<div className={styles.filterLeft}>
|
||||||
|
<HomepageFilter
|
||||||
|
filterOptions={status}
|
||||||
|
onChange={statusOnChange}
|
||||||
|
placeHolder="Status"
|
||||||
|
value={statusState}
|
||||||
|
/>
|
||||||
|
</div>
|
||||||
|
<div className={styles.filterLeft}>
|
||||||
|
<HomepageFilter
|
||||||
|
filterOptions={uniqueTag}
|
||||||
|
onChange={tagOnChange}
|
||||||
|
placeHolder="Tags"
|
||||||
|
value={tagState}
|
||||||
|
/>
|
||||||
|
</div>
|
||||||
|
<div className={styles.filterLeft}>
|
||||||
|
<HomepageFilter
|
||||||
|
filterOptions={uniqueGroup}
|
||||||
|
onChange={groupOnChange}
|
||||||
|
placeHolder="Groups"
|
||||||
|
value={groupState}
|
||||||
|
/>
|
||||||
|
</div>
|
||||||
|
<div className={styles.filterLeft}>
|
||||||
|
<HomepageFilter<string>
|
||||||
|
filterOptions={
|
||||||
|
agentVersionsQuery.data?.map((v) => ({
|
||||||
|
label: v,
|
||||||
|
value: v,
|
||||||
|
})) || []
|
||||||
|
}
|
||||||
|
onChange={setAgentVersions}
|
||||||
|
placeHolder="Agent Version"
|
||||||
|
value={agentVersions}
|
||||||
|
/>
|
||||||
|
</div>
|
||||||
|
<button
|
||||||
|
type="button"
|
||||||
|
className={styles.clearButton}
|
||||||
|
onClick={clearFilter}
|
||||||
|
>
|
||||||
|
Clear all
|
||||||
|
</button>
|
||||||
|
<div className={styles.filterRight}>
|
||||||
|
<SortbySelector
|
||||||
|
filterOptions={sortByOptions}
|
||||||
|
onChange={sortOnchange}
|
||||||
|
onDescending={sortOnDescending}
|
||||||
|
placeHolder="Sort By"
|
||||||
|
sortByDescending={sortByDescending}
|
||||||
|
sortByButton={sortByButton}
|
||||||
|
value={sortByState}
|
||||||
|
/>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
<div className="blocklist" data-cy="home-endpointList">
|
||||||
|
{renderItems(
|
||||||
|
isLoading,
|
||||||
|
totalCount,
|
||||||
|
environments.map((env) => (
|
||||||
|
<EnvironmentItem
|
||||||
|
key={env.Id}
|
||||||
|
environment={env}
|
||||||
|
groupName={
|
||||||
|
groupsQuery.data?.find((g) => g.Id === env.GroupId)?.Name
|
||||||
|
}
|
||||||
|
onClick={onClickItem}
|
||||||
|
/>
|
||||||
|
))
|
||||||
|
)}
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<TableFooter>
|
||||||
|
<PaginationControls
|
||||||
|
showAll={totalCount <= 100}
|
||||||
|
pageLimit={pageLimit}
|
||||||
|
page={page}
|
||||||
|
onPageChange={setPage}
|
||||||
|
totalCount={totalCount}
|
||||||
|
onPageLimitChange={setPageLimit}
|
||||||
|
/>
|
||||||
|
</TableFooter>
|
||||||
|
</TableContainer>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</>
|
||||||
|
);
|
||||||
|
|
||||||
|
function getEdgeDeviceFilter(connectionTypes: ConnectionType[]) {
|
||||||
|
// show both types of edge agent if both are selected or if no connection type is selected
|
||||||
|
if (
|
||||||
|
connectionTypes.length === 0 ||
|
||||||
|
(connectionTypes.includes(ConnectionType.EdgeAgent) &&
|
||||||
|
connectionTypes.includes(ConnectionType.EdgeDevice))
|
||||||
|
) {
|
||||||
|
return undefined;
|
||||||
|
}
|
||||||
|
|
||||||
|
return connectionTypes.includes(ConnectionType.EdgeDevice);
|
||||||
|
}
|
||||||
|
|
||||||
|
function getTypes(
|
||||||
|
platformTypes: PlatformType[],
|
||||||
|
connectionTypes: ConnectionType[]
|
||||||
|
) {
|
||||||
|
if (platformTypes.length === 0 && connectionTypes.length === 0) {
|
||||||
|
return [];
|
||||||
|
}
|
||||||
|
|
||||||
|
const typesByPlatform = {
|
||||||
|
[PlatformType.Docker]: [
|
||||||
|
EnvironmentType.Docker,
|
||||||
EnvironmentType.AgentOnDocker,
|
EnvironmentType.AgentOnDocker,
|
||||||
EnvironmentType.EdgeAgentOnDocker,
|
EnvironmentType.EdgeAgentOnDocker,
|
||||||
];
|
],
|
||||||
const kubernetesRelateType = [
|
[PlatformType.Azure]: [EnvironmentType.Azure],
|
||||||
|
[PlatformType.Kubernetes]: [
|
||||||
|
EnvironmentType.KubernetesLocal,
|
||||||
EnvironmentType.AgentOnKubernetes,
|
EnvironmentType.AgentOnKubernetes,
|
||||||
EnvironmentType.EdgeAgentOnKubernetes,
|
EnvironmentType.EdgeAgentOnKubernetes,
|
||||||
];
|
],
|
||||||
|
};
|
||||||
|
|
||||||
if (filterOptions.length === 0) {
|
const typesByConnection = {
|
||||||
setPlatformType(allEnvironmentType);
|
[ConnectionType.API]: [
|
||||||
} else {
|
EnvironmentType.Azure,
|
||||||
let finalFilterEnvironment = filterOptions.map(
|
EnvironmentType.KubernetesLocal,
|
||||||
(filterOption) => filterOption.value
|
EnvironmentType.Docker,
|
||||||
|
],
|
||||||
|
[ConnectionType.Agent]: [
|
||||||
|
EnvironmentType.AgentOnDocker,
|
||||||
|
EnvironmentType.AgentOnKubernetes,
|
||||||
|
],
|
||||||
|
[ConnectionType.EdgeAgent]: EdgeTypes,
|
||||||
|
[ConnectionType.EdgeDevice]: EdgeTypes,
|
||||||
|
};
|
||||||
|
|
||||||
|
const selectedTypesByPlatform = platformTypes.flatMap(
|
||||||
|
(platformType) => typesByPlatform[platformType]
|
||||||
);
|
);
|
||||||
if (finalFilterEnvironment.includes(dockerBaseType)) {
|
const selectedTypesByConnection = connectionTypes.flatMap(
|
||||||
finalFilterEnvironment = [
|
(connectionType) => typesByConnection[connectionType]
|
||||||
...finalFilterEnvironment,
|
);
|
||||||
...dockerRelateType,
|
|
||||||
];
|
if (selectedTypesByPlatform.length === 0) {
|
||||||
|
return selectedTypesByConnection;
|
||||||
}
|
}
|
||||||
if (finalFilterEnvironment.includes(kubernetesBaseType)) {
|
|
||||||
finalFilterEnvironment = [
|
if (selectedTypesByConnection.length === 0) {
|
||||||
...finalFilterEnvironment,
|
return selectedTypesByPlatform;
|
||||||
...kubernetesRelateType,
|
|
||||||
];
|
|
||||||
}
|
|
||||||
setPlatformType(finalFilterEnvironment);
|
|
||||||
}
|
}
|
||||||
|
|
||||||
|
return _.intersection(selectedTypesByConnection, selectedTypesByPlatform);
|
||||||
}
|
}
|
||||||
|
|
||||||
function statusOnChange(filterOptions: Filter[]) {
|
function statusOnChange(filterOptions: Filter[]) {
|
||||||
|
@ -245,8 +447,7 @@ export function EnvironmentList({ onClickItem, onRefresh }: Props) {
|
||||||
}
|
}
|
||||||
|
|
||||||
function clearFilter() {
|
function clearFilter() {
|
||||||
setPlatformState([]);
|
setPlatformTypes([]);
|
||||||
setPlatformType(allEnvironmentType);
|
|
||||||
setStatusState([]);
|
setStatusState([]);
|
||||||
setStatusFilter([]);
|
setStatusFilter([]);
|
||||||
setTagState([]);
|
setTagState([]);
|
||||||
|
@ -267,149 +468,67 @@ export function EnvironmentList({ onClickItem, onRefresh }: Props) {
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
function sortOndescending() {
|
function sortOnDescending() {
|
||||||
setSortByDescending(!sortByDescending);
|
setSortByDescending(!sortByDescending);
|
||||||
}
|
}
|
||||||
|
|
||||||
return (
|
|
||||||
<>
|
|
||||||
{totalAvailable === 0 && <NoEnvironmentsInfoPanel isAdmin={isAdmin} />}
|
|
||||||
<div className="row">
|
|
||||||
<div className="col-sm-12">
|
|
||||||
<TableContainer>
|
|
||||||
<TableTitle icon="hard-drive" featherIcon label="Environments" />
|
|
||||||
|
|
||||||
<TableActions className={styles.actionBar}>
|
|
||||||
<div className={styles.description}>
|
|
||||||
Click on an environment to manage
|
|
||||||
</div>
|
|
||||||
<div className={styles.actionButton}>
|
|
||||||
<div className={styles.refreshButton}>
|
|
||||||
{isAdmin && (
|
|
||||||
<Button
|
|
||||||
onClick={onRefresh}
|
|
||||||
data-cy="home-refreshEndpointsButton"
|
|
||||||
className={clsx(
|
|
||||||
'vertical-center',
|
|
||||||
styles.refreshEnvironmentsButton
|
|
||||||
)}
|
|
||||||
>
|
|
||||||
<RefreshCcw
|
|
||||||
className="feather icon-sm icon-white"
|
|
||||||
aria-hidden="true"
|
|
||||||
/>
|
|
||||||
Refresh
|
|
||||||
</Button>
|
|
||||||
)}
|
|
||||||
</div>
|
|
||||||
<div className={styles.kubeconfigButton}>
|
|
||||||
<KubeconfigButton
|
|
||||||
environments={environments}
|
|
||||||
envQueryParams={{
|
|
||||||
types: platformType,
|
|
||||||
search: debouncedTextFilter,
|
|
||||||
status: statusFilter,
|
|
||||||
tagIds: tagFilter?.length ? tagFilter : undefined,
|
|
||||||
groupIds: groupFilter,
|
|
||||||
sort: sortByFilter,
|
|
||||||
order: sortByDescending ? 'desc' : 'asc',
|
|
||||||
edgeDevice: false,
|
|
||||||
}}
|
|
||||||
/>
|
|
||||||
</div>
|
|
||||||
<div className={styles.filterSearchbar}>
|
|
||||||
<FilterSearchBar
|
|
||||||
value={searchBarValue}
|
|
||||||
onChange={setSearchBarValue}
|
|
||||||
placeholder="Search by name, group, tag, status, URL..."
|
|
||||||
data-cy="home-endpointsSearchInput"
|
|
||||||
/>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</TableActions>
|
|
||||||
<div className={styles.filterContainer}>
|
|
||||||
<div className={styles.filterLeft}>
|
|
||||||
<HomepageFilter
|
|
||||||
filterOptions={PlatformOptions}
|
|
||||||
onChange={platformOnChange}
|
|
||||||
placeHolder="Platform"
|
|
||||||
value={platformState}
|
|
||||||
/>
|
|
||||||
</div>
|
|
||||||
<div className={styles.filterLeft}>
|
|
||||||
<HomepageFilter
|
|
||||||
filterOptions={status}
|
|
||||||
onChange={statusOnChange}
|
|
||||||
placeHolder="Status"
|
|
||||||
value={statusState}
|
|
||||||
/>
|
|
||||||
</div>
|
|
||||||
<div className={styles.filterLeft}>
|
|
||||||
<HomepageFilter
|
|
||||||
filterOptions={uniqueTag}
|
|
||||||
onChange={tagOnChange}
|
|
||||||
placeHolder="Tags"
|
|
||||||
value={tagState}
|
|
||||||
/>
|
|
||||||
</div>
|
|
||||||
<div className={styles.filterLeft}>
|
|
||||||
<HomepageFilter
|
|
||||||
filterOptions={uniqueGroup}
|
|
||||||
onChange={groupOnChange}
|
|
||||||
placeHolder="Groups"
|
|
||||||
value={groupState}
|
|
||||||
/>
|
|
||||||
</div>
|
|
||||||
<button
|
|
||||||
type="button"
|
|
||||||
className={styles.clearButton}
|
|
||||||
onClick={clearFilter}
|
|
||||||
>
|
|
||||||
Clear all
|
|
||||||
</button>
|
|
||||||
<div className={styles.filterRight}>
|
|
||||||
<SortbySelector
|
|
||||||
filterOptions={SortByOptions}
|
|
||||||
onChange={sortOnchange}
|
|
||||||
onDescending={sortOndescending}
|
|
||||||
placeHolder="Sort By"
|
|
||||||
sortByDescending={sortByDescending}
|
|
||||||
sortByButton={sortByButton}
|
|
||||||
value={sortByState}
|
|
||||||
/>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
<div className="blocklist" data-cy="home-endpointList">
|
|
||||||
{renderItems(
|
|
||||||
isLoading,
|
|
||||||
totalCount,
|
|
||||||
environments.map((env) => (
|
|
||||||
<EnvironmentItem
|
|
||||||
key={env.Id}
|
|
||||||
environment={env}
|
|
||||||
groupName={
|
|
||||||
groupsQuery.data?.find((g) => g.Id === env.GroupId)?.Name
|
|
||||||
}
|
}
|
||||||
onClick={onClickItem}
|
|
||||||
/>
|
|
||||||
))
|
|
||||||
)}
|
|
||||||
</div>
|
|
||||||
|
|
||||||
<TableFooter>
|
function getConnectionTypeOptions(platformTypes: Filter<PlatformType>[]) {
|
||||||
<PaginationControls
|
const platformTypeConnectionType = {
|
||||||
showAll={totalCount <= 100}
|
[PlatformType.Docker]: [
|
||||||
pageLimit={pageLimit}
|
ConnectionType.API,
|
||||||
page={page}
|
ConnectionType.Agent,
|
||||||
onPageChange={setPage}
|
ConnectionType.EdgeAgent,
|
||||||
totalCount={totalCount}
|
ConnectionType.EdgeDevice,
|
||||||
onPageLimitChange={setPageLimit}
|
],
|
||||||
/>
|
[PlatformType.Azure]: [ConnectionType.API],
|
||||||
</TableFooter>
|
[PlatformType.Kubernetes]: [
|
||||||
</TableContainer>
|
ConnectionType.Agent,
|
||||||
</div>
|
ConnectionType.EdgeAgent,
|
||||||
</div>
|
ConnectionType.EdgeDevice,
|
||||||
</>
|
],
|
||||||
|
};
|
||||||
|
|
||||||
|
const connectionTypesDefaultOptions = [
|
||||||
|
{ value: ConnectionType.API, label: 'API' },
|
||||||
|
{ value: ConnectionType.Agent, label: 'Agent' },
|
||||||
|
{ value: ConnectionType.EdgeAgent, label: 'Edge Agent' },
|
||||||
|
{ value: ConnectionType.EdgeDevice, label: 'Edge Device' },
|
||||||
|
];
|
||||||
|
|
||||||
|
if (platformTypes.length === 0) {
|
||||||
|
return connectionTypesDefaultOptions;
|
||||||
|
}
|
||||||
|
|
||||||
|
return _.compact(
|
||||||
|
_.intersection(
|
||||||
|
...platformTypes.map((p) => platformTypeConnectionType[p.value])
|
||||||
|
).map((c) => connectionTypesDefaultOptions.find((o) => o.value === c))
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
function getPlatformTypeOptions(connectionTypes: Filter<ConnectionType>[]) {
|
||||||
|
const platformDefaultOptions = [
|
||||||
|
{ value: PlatformType.Docker, label: 'Docker' },
|
||||||
|
{ value: PlatformType.Azure, label: 'Azure' },
|
||||||
|
{ value: PlatformType.Kubernetes, label: 'Kubernetes' },
|
||||||
|
];
|
||||||
|
|
||||||
|
if (connectionTypes.length === 0) {
|
||||||
|
return platformDefaultOptions;
|
||||||
|
}
|
||||||
|
|
||||||
|
const connectionTypePlatformType = {
|
||||||
|
[ConnectionType.API]: [PlatformType.Docker, PlatformType.Azure],
|
||||||
|
[ConnectionType.Agent]: [PlatformType.Docker, PlatformType.Kubernetes],
|
||||||
|
[ConnectionType.EdgeAgent]: [PlatformType.Kubernetes, PlatformType.Docker],
|
||||||
|
[ConnectionType.EdgeDevice]: [PlatformType.Docker, PlatformType.Kubernetes],
|
||||||
|
};
|
||||||
|
|
||||||
|
return _.compact(
|
||||||
|
_.intersection(
|
||||||
|
...connectionTypes.map((p) => connectionTypePlatformType[p.value])
|
||||||
|
).map((c) => platformDefaultOptions.find((o) => o.value === c))
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
|
@ -2,14 +2,15 @@ import { useState } from 'react';
|
||||||
import { Download } from 'react-feather';
|
import { Download } from 'react-feather';
|
||||||
|
|
||||||
import { Environment } from '@/portainer/environments/types';
|
import { Environment } from '@/portainer/environments/types';
|
||||||
import { Query } from '@/portainer/environments/queries/useEnvironmentList';
|
|
||||||
import { isKubernetesEnvironment } from '@/portainer/environments/utils';
|
import { isKubernetesEnvironment } from '@/portainer/environments/utils';
|
||||||
import { trackEvent } from '@/angulartics.matomo/analytics-services';
|
import { trackEvent } from '@/angulartics.matomo/analytics-services';
|
||||||
|
import { Query } from '@/portainer/environments/queries/useEnvironmentList';
|
||||||
|
|
||||||
import { Button } from '@@/buttons';
|
import { Button } from '@@/buttons';
|
||||||
|
|
||||||
import styles from './KubeconfigButton.module.css';
|
import styles from './KubeconfigButton.module.css';
|
||||||
import { KubeconfigPrompt } from './KubeconfigPrompt';
|
import { KubeconfigPrompt } from './KubeconfigPrompt';
|
||||||
|
|
||||||
import '@reach/dialog/styles.css';
|
import '@reach/dialog/styles.css';
|
||||||
|
|
||||||
export interface Props {
|
export interface Props {
|
||||||
|
|
|
@ -4,10 +4,12 @@ import { DialogOverlay } from '@reach/dialog';
|
||||||
import * as kcService from '@/kubernetes/services/kubeconfig.service';
|
import * as kcService from '@/kubernetes/services/kubeconfig.service';
|
||||||
import * as notifications from '@/portainer/services/notifications';
|
import * as notifications from '@/portainer/services/notifications';
|
||||||
import { EnvironmentType } from '@/portainer/environments/types';
|
import { EnvironmentType } from '@/portainer/environments/types';
|
||||||
import { EnvironmentsQueryParams } from '@/portainer/environments/environment.service/index';
|
|
||||||
import { usePaginationLimitState } from '@/portainer/hooks/usePaginationLimitState';
|
import { usePaginationLimitState } from '@/portainer/hooks/usePaginationLimitState';
|
||||||
import { useEnvironmentList } from '@/portainer/environments/queries/useEnvironmentList';
|
|
||||||
import { usePublicSettings } from '@/portainer/settings/queries';
|
import { usePublicSettings } from '@/portainer/settings/queries';
|
||||||
|
import {
|
||||||
|
Query,
|
||||||
|
useEnvironmentList,
|
||||||
|
} from '@/portainer/environments/queries/useEnvironmentList';
|
||||||
|
|
||||||
import { PaginationControls } from '@@/PaginationControls';
|
import { PaginationControls } from '@@/PaginationControls';
|
||||||
import { Checkbox } from '@@/form-components/Checkbox';
|
import { Checkbox } from '@@/form-components/Checkbox';
|
||||||
|
@ -18,7 +20,7 @@ import styles from './KubeconfigPrompt.module.css';
|
||||||
import '@reach/dialog/styles.css';
|
import '@reach/dialog/styles.css';
|
||||||
|
|
||||||
export interface KubeconfigPromptProps {
|
export interface KubeconfigPromptProps {
|
||||||
envQueryParams: EnvironmentsQueryParams;
|
envQueryParams: Query;
|
||||||
onClose: () => void;
|
onClose: () => void;
|
||||||
}
|
}
|
||||||
const storageKey = 'home_endpoints';
|
const storageKey = 'home_endpoints';
|
||||||
|
|
|
@ -5,14 +5,14 @@ import { Filter } from '@/portainer/home/types';
|
||||||
|
|
||||||
import { Select } from '@@/form-components/ReactSelect';
|
import { Select } from '@@/form-components/ReactSelect';
|
||||||
|
|
||||||
interface Props {
|
interface Props<TValue = number> {
|
||||||
filterOptions: Filter[];
|
filterOptions?: Filter<TValue>[];
|
||||||
onChange: (filterOptions: Filter[]) => void;
|
onChange: (filterOptions: Filter<TValue>[]) => void;
|
||||||
placeHolder: string;
|
placeHolder: string;
|
||||||
value: Filter[];
|
value: Filter<TValue>[];
|
||||||
}
|
}
|
||||||
|
|
||||||
function Option(props: OptionProps<Filter, true>) {
|
function Option<TValue = number>(props: OptionProps<Filter<TValue>, true>) {
|
||||||
const { isSelected, label } = props;
|
const { isSelected, label } = props;
|
||||||
return (
|
return (
|
||||||
<div>
|
<div>
|
||||||
|
@ -27,12 +27,12 @@ function Option(props: OptionProps<Filter, true>) {
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
export function HomepageFilter({
|
export function HomepageFilter<TValue = number>({
|
||||||
filterOptions,
|
filterOptions = [],
|
||||||
onChange,
|
onChange,
|
||||||
placeHolder,
|
placeHolder,
|
||||||
value,
|
value,
|
||||||
}: Props) {
|
}: Props<TValue>) {
|
||||||
return (
|
return (
|
||||||
<Select
|
<Select
|
||||||
closeMenuOnSelect={false}
|
closeMenuOnSelect={false}
|
||||||
|
@ -41,7 +41,7 @@ export function HomepageFilter({
|
||||||
value={value}
|
value={value}
|
||||||
isMulti
|
isMulti
|
||||||
components={{ Option }}
|
components={{ Option }}
|
||||||
onChange={(option) => onChange(option as Filter[])}
|
onChange={(option) => onChange([...option])}
|
||||||
/>
|
/>
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
@ -51,27 +51,9 @@ export function useHomePageFilter<T>(
|
||||||
defaultValue: T
|
defaultValue: T
|
||||||
): [T, (value: T) => void] {
|
): [T, (value: T) => void] {
|
||||||
const filterKey = keyBuilder(key);
|
const filterKey = keyBuilder(key);
|
||||||
const [storageValue, setStorageValue] = useLocalStorage(
|
return useLocalStorage(filterKey, defaultValue, sessionStorage);
|
||||||
filterKey,
|
|
||||||
JSON.stringify(defaultValue),
|
|
||||||
sessionStorage
|
|
||||||
);
|
|
||||||
const value = jsonParse(storageValue, defaultValue);
|
|
||||||
return [value, setValue];
|
|
||||||
|
|
||||||
function setValue(value?: T) {
|
|
||||||
setStorageValue(JSON.stringify(value));
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
function keyBuilder(key: string) {
|
function keyBuilder(key: string) {
|
||||||
return `datatable_home_filter_type_${key}`;
|
return `datatable_home_filter_type_${key}`;
|
||||||
}
|
}
|
||||||
|
|
||||||
function jsonParse<T>(value: string, defaultValue: T): T {
|
|
||||||
try {
|
|
||||||
return JSON.parse(value);
|
|
||||||
} catch (e) {
|
|
||||||
return defaultValue;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
|
@ -6,7 +6,7 @@ export interface Motd {
|
||||||
ContentLayout?: Record<string, string>;
|
ContentLayout?: Record<string, string>;
|
||||||
}
|
}
|
||||||
|
|
||||||
export interface Filter {
|
export interface Filter<T = number> {
|
||||||
value: number;
|
value: T;
|
||||||
label: string;
|
label: string;
|
||||||
}
|
}
|
||||||
|
|
|
@ -92,5 +92,8 @@ export function createMockEnvironment(): Environment {
|
||||||
enableHostManagementFeatures: false,
|
enableHostManagementFeatures: false,
|
||||||
},
|
},
|
||||||
Gpus: [],
|
Gpus: [],
|
||||||
|
Agent: {
|
||||||
|
Version: '',
|
||||||
|
},
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|
|
@ -4,6 +4,7 @@ import { Environment } from '@/portainer/environments/types';
|
||||||
import { useCreateEdgeAgentEnvironmentMutation } from '@/portainer/environments/queries/useCreateEnvironmentMutation';
|
import { useCreateEdgeAgentEnvironmentMutation } from '@/portainer/environments/queries/useCreateEnvironmentMutation';
|
||||||
import { baseHref } from '@/portainer/helpers/pathHelper';
|
import { baseHref } from '@/portainer/helpers/pathHelper';
|
||||||
import { EdgeCheckinIntervalField } from '@/edge/components/EdgeCheckInIntervalField';
|
import { EdgeCheckinIntervalField } from '@/edge/components/EdgeCheckInIntervalField';
|
||||||
|
import { useCreateEdgeDeviceParam } from '@/react/portainer/environments/wizard/hooks/useCreateEdgeDeviceParam';
|
||||||
|
|
||||||
import { FormSection } from '@@/form-components/FormSection';
|
import { FormSection } from '@@/form-components/FormSection';
|
||||||
import { LoadingButton } from '@@/buttons/LoadingButton';
|
import { LoadingButton } from '@@/buttons/LoadingButton';
|
||||||
|
@ -24,6 +25,8 @@ interface Props {
|
||||||
const initialValues = buildInitialValues();
|
const initialValues = buildInitialValues();
|
||||||
|
|
||||||
export function EdgeAgentForm({ onCreate, readonly, showGpus = false }: Props) {
|
export function EdgeAgentForm({ onCreate, readonly, showGpus = false }: Props) {
|
||||||
|
const createEdgeDevice = useCreateEdgeDeviceParam();
|
||||||
|
|
||||||
const createMutation = useCreateEdgeAgentEnvironmentMutation();
|
const createMutation = useCreateEdgeAgentEnvironmentMutation();
|
||||||
|
|
||||||
return (
|
return (
|
||||||
|
@ -68,11 +71,14 @@ export function EdgeAgentForm({ onCreate, readonly, showGpus = false }: Props) {
|
||||||
);
|
);
|
||||||
|
|
||||||
function handleSubmit(values: typeof initialValues) {
|
function handleSubmit(values: typeof initialValues) {
|
||||||
createMutation.mutate(values, {
|
createMutation.mutate(
|
||||||
|
{ ...values, isEdgeDevice: createEdgeDevice },
|
||||||
|
{
|
||||||
onSuccess(environment) {
|
onSuccess(environment) {
|
||||||
onCreate(environment);
|
onCreate(environment);
|
||||||
},
|
},
|
||||||
});
|
}
|
||||||
|
);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue