2021-08-05 03:02:06 +00:00
|
|
|
package kubernetes
|
|
|
|
|
|
|
|
import (
|
|
|
|
"errors"
|
|
|
|
"fmt"
|
feat(helm/templates): helm app templates EE-943 (#5449)
* feat(helm): add helm chart backport to ce EE-1409 (#5425)
* EE-1311 Helm Chart Backport from EE
* backport to ce
Co-authored-by: Matt Hook <hookenz@gmail.com>
* feat(helm): list and configure helm chart (#5431)
* backport and tidyup code
* --amend
* using rocket icon for charts
* helm chart bugfix - clear category button
* added matomo analytics for helm chart install
* fix web editor exit warning without changes
* editor modified exit bugfix
* fixed notifications typo
* updated helm template text
* helper text to convey slow helm templates load
Co-authored-by: zees-dev <dev.786zshan@gmail.com>
* removing redundant time-consuming api call by using prop attribute
* feat(helm) helm chart backport from ee EE-1311 (#5436)
* Add missing defaultHelmRepoUrl and mock testing
* Backport EE-1477
* Backport updates to helm tests from EE
* add https by default changes and ssl to tls renaming from EE
* Port install integration test. Disabled by default to pass CI checks
* merged changes from EE for the integration test
* kube proxy whitelist updated to support internal helm install command
Co-authored-by: zees-dev <dev.786zshan@gmail.com>
* Pull in all changes from tech review in EE-943
* added helm to sidebar after rebase, sync CE with EE
* bugfix: kubectl shell not opening - bearer token bug
* tidy go modules & remove yarn-error.log
* removed redundant handler (not used) - to match EE
* resolved merge conflicts, updated code
* feat(helm/views): helm release and application views EE-1236 (#5529)
* feat(helm): add helm chart backport to ce EE-1409 (#5425)
* EE-1311 Helm Chart Backport from EE
* backport to ce
Co-authored-by: Matt Hook <hookenz@gmail.com>
* Pull in all changes from tech review in EE-943
* added helm to sidebar after rebase, sync CE with EE
* removed redundant handler (not used) - to match EE
* feat(helm) display helm charts - backend EE-1236
* copy over components for new applications view EE-1236
* Add new applications datatable component
* Add more migrated files
* removed test not applicable to CE
* baclkported EE app data table code to CE
* removed redundant helm repo url
* resolved conflicts, updated code
* using endpoint middleware
* PR review fixes
* using constants, openapi updated
Co-authored-by: Richard Wei <54336863+WaysonWei@users.noreply.github.com>
Co-authored-by: zees-dev <dev.786zshan@gmail.com>
* fixed test conflicts, go linted
* feat(helm/templates-add): helm templates add repo for user support EE-1278 (#5514)
* feat(helm): add helm chart backport to ce EE-1409 (#5425)
* EE-1311 Helm Chart Backport from EE
* backport to ce
Co-authored-by: Matt Hook <hookenz@gmail.com>
* feat(helm) helm chart backport from ee EE-1311 (#5436)
* Add missing defaultHelmRepoUrl and mock testing
* Backport EE-1477
* Backport updates to helm tests from EE
* add https by default changes and ssl to tls renaming from EE
* Port install integration test. Disabled by default to pass CI checks
* merged changes from EE for the integration test
* kube proxy whitelist updated to support internal helm install command
Co-authored-by: zees-dev <dev.786zshan@gmail.com>
* Pull in all changes from tech review in EE-943
* feat(helm): add helm chart backport to ce EE-1409 (#5425)
* EE-1311 Helm Chart Backport from EE
* backport to ce
Co-authored-by: Matt Hook <hookenz@gmail.com>
* Pull in all changes from tech review in EE-943
* added helm to sidebar after rebase, sync CE with EE
* backport EE-1278, squashed, diffed, updated
* helm install openapi spec update
* resolved conflicts, updated code
* - matching ee codebase at 0afe57034449ee0e9f333d92c252a13995a93019
- helm install using endpoint middleware
- remove trailing slash from added/persisted helm repo urls
* feat(helm) use libhelm url validator and improved path assembly EE-1554 (#5561)
* feat(helm/userrepos) fix getting global repo for ordinary users EE-1562 (#5567)
* feat(helm/userrepos) fix getting global repo for ordinary users EE-1562
* post review changes and further backported changes from EE
* resolved conflicts, updated code
* fixed helm_install handler unit test
* user cannot add existing repo if suffix is '/' (#5571)
* feat(helm/docs) fix broken swagger docs EE-1278 (#5572)
* Fix swagger docs
* minor correction
* fix(helm): migrating code from user handler to helm handler (#5573)
* - migrated user_helm_repos to helm endpoint handler
- migrated api operations from user factory/service to helm factory/service
- passing endpointId into helm service/factory as endpoint provider is deprecated
* upgrade libhelm to hide secrets
Co-authored-by: Matt Hook <hookenz@gmail.com>
* removed duplicate file - due to merge conflict
* dependency injection in helm factory
Co-authored-by: Richard Wei <54336863+WaysonWei@users.noreply.github.com>
Co-authored-by: Matt Hook <hookenz@gmail.com>
* kubernetes.templates -> kubernetes.templates.helm name conflict fix
* Validate the URL added as a public helm repo (#5579)
* fix(helm): helm app deletion fix EE-1581 (#5582)
* updated helm lib to show correct error on uninstall failure
* passing down helm app namespace on deletion
* fix(k8s): EE-1591 non-admin users cannot deploy charts containing secrets (#5590)
Co-authored-by: Simon Meng <simon.meng@portainer.io>
* fix(helm): helm epic bugfixes EE-1582 EE-1593 (#5585)
* - trim trailing slash and lowercase before persisting helm repo
- browser helm templates url /kubernetes/templates/templates -> /kubernetes/templates/helm
- fix publish url
- fix helm repo add refresh
- semi-fix k8s app expansion
* Tidy up swagger documentation related to helm. Make json consistent
* fixed helm release page for non-default namespaces
* k8s app view table expansion bugfix
* EE-1593: publish url load balancer fallback
Co-authored-by: Matt Hook <hookenz@gmail.com>
* k8s app list fix for charts with deployments containing multiple pods - which use the same label (#5599)
* fix(kubernetes): app list view fix for secrets with long keys or values EE-1600 (#5600)
* k8s app secrets key value text overflow ellipses
* wrapping key value pairs instead of ellipses
* fix(helm): helm apps bundling issue across different namespaces EE-1619 (#5602)
* helm apps bundling issue across different namespaces
* - code comments and indentation to ease reading
- moved namespace calc out of loop
* feat(helm/test) disable slow helm search test by default EE-1599 (#5598)
* skip helm_repo_search as it's an integration test
* switch to portainer built in integration test checker
* make module order match EE
* don't print test struct out when skipping integration test
Co-authored-by: Richard Wei <54336863+WaysonWei@users.noreply.github.com>
Co-authored-by: Matt Hook <hookenz@gmail.com>
Co-authored-by: cong meng <mcpacino@gmail.com>
Co-authored-by: Simon Meng <simon.meng@portainer.io>
2021-09-10 02:06:57 +00:00
|
|
|
"net/http"
|
|
|
|
|
2021-08-05 03:02:06 +00:00
|
|
|
httperror "github.com/portainer/libhttp/error"
|
|
|
|
"github.com/portainer/libhttp/request"
|
|
|
|
"github.com/portainer/libhttp/response"
|
|
|
|
portainer "github.com/portainer/portainer/api"
|
|
|
|
"github.com/portainer/portainer/api/http/security"
|
2021-11-22 18:05:09 +00:00
|
|
|
"github.com/portainer/portainer/api/internal/endpointutils"
|
2021-08-05 03:02:06 +00:00
|
|
|
kcli "github.com/portainer/portainer/api/kubernetes/cli"
|
2021-12-06 21:40:59 +00:00
|
|
|
clientV1 "k8s.io/client-go/tools/clientcmd/api/v1"
|
2021-08-05 03:02:06 +00:00
|
|
|
)
|
|
|
|
|
|
|
|
// @id GetKubernetesConfig
|
|
|
|
// @summary Generates kubeconfig file enabling client communication with k8s api server
|
|
|
|
// @description Generates kubeconfig file enabling client communication with k8s api server
|
2021-10-11 23:12:08 +00:00
|
|
|
// @description **Access policy**: authenticated
|
2021-08-05 03:02:06 +00:00
|
|
|
// @tags kubernetes
|
2021-11-30 02:31:16 +00:00
|
|
|
// @security ApiKeyAuth
|
2021-08-05 03:02:06 +00:00
|
|
|
// @security jwt
|
|
|
|
// @accept json
|
|
|
|
// @produce json
|
2021-11-22 18:05:09 +00:00
|
|
|
// @param ids query []int false "will include only these environments(endpoints)"
|
|
|
|
// @param excludeIds query []int false "will exclude these environments(endpoints)"
|
2021-08-05 03:02:06 +00:00
|
|
|
// @success 200 "Success"
|
|
|
|
// @failure 400 "Invalid request"
|
|
|
|
// @failure 401 "Unauthorized"
|
|
|
|
// @failure 403 "Permission denied"
|
2021-09-20 00:14:22 +00:00
|
|
|
// @failure 404 "Environment(Endpoint) or ServiceAccount not found"
|
2021-08-05 03:02:06 +00:00
|
|
|
// @failure 500 "Server error"
|
2021-11-22 18:05:09 +00:00
|
|
|
// @router /kubernetes/config [get]
|
2021-08-05 03:02:06 +00:00
|
|
|
func (handler *Handler) getKubernetesConfig(w http.ResponseWriter, r *http.Request) *httperror.HandlerError {
|
2021-11-22 18:05:09 +00:00
|
|
|
tokenData, err := security.RetrieveTokenData(r)
|
2021-08-05 03:02:06 +00:00
|
|
|
if err != nil {
|
2021-11-22 18:05:09 +00:00
|
|
|
return &httperror.HandlerError{http.StatusForbidden, "Permission denied to access environment", err}
|
|
|
|
}
|
2022-03-21 12:51:29 +00:00
|
|
|
bearerToken, err := handler.jwtService.GenerateTokenForKubeconfig(tokenData)
|
2021-11-22 18:05:09 +00:00
|
|
|
if err != nil {
|
|
|
|
return &httperror.HandlerError{http.StatusInternalServerError, "Unable to generate JWT token", err}
|
2021-08-05 03:02:06 +00:00
|
|
|
}
|
|
|
|
|
2021-11-22 18:05:09 +00:00
|
|
|
endpoints, handlerErr := handler.filterUserKubeEndpoints(r)
|
|
|
|
if handlerErr != nil {
|
|
|
|
return handlerErr
|
|
|
|
}
|
|
|
|
if len(endpoints) == 0 {
|
|
|
|
return &httperror.HandlerError{http.StatusBadRequest, "empty endpoints list", errors.New("empty endpoints list")}
|
2021-08-05 03:02:06 +00:00
|
|
|
}
|
|
|
|
|
2021-11-22 18:05:09 +00:00
|
|
|
config, handlerErr := handler.buildConfig(r, tokenData, bearerToken, endpoints)
|
|
|
|
if handlerErr != nil {
|
|
|
|
return handlerErr
|
2021-08-05 03:02:06 +00:00
|
|
|
}
|
|
|
|
|
2021-11-22 18:05:09 +00:00
|
|
|
return writeFileContent(w, r, endpoints, tokenData, config)
|
|
|
|
}
|
|
|
|
|
|
|
|
func (handler *Handler) filterUserKubeEndpoints(r *http.Request) ([]portainer.Endpoint, *httperror.HandlerError) {
|
|
|
|
var endpointIDs []portainer.EndpointID
|
|
|
|
_ = request.RetrieveJSONQueryParameter(r, "ids", &endpointIDs, true)
|
|
|
|
|
|
|
|
var excludeEndpointIDs []portainer.EndpointID
|
|
|
|
_ = request.RetrieveJSONQueryParameter(r, "excludeIds", &excludeEndpointIDs, true)
|
|
|
|
|
|
|
|
if len(endpointIDs) > 0 && len(excludeEndpointIDs) > 0 {
|
|
|
|
return nil, &httperror.HandlerError{http.StatusBadRequest, "Can't provide both 'ids' and 'excludeIds' parameters", errors.New("invalid parameters")}
|
|
|
|
}
|
|
|
|
|
|
|
|
securityContext, err := security.RetrieveRestrictedRequestContext(r)
|
2021-08-05 03:02:06 +00:00
|
|
|
if err != nil {
|
2021-11-22 18:05:09 +00:00
|
|
|
return nil, &httperror.HandlerError{http.StatusInternalServerError, "Unable to retrieve info from request context", err}
|
2021-08-05 03:02:06 +00:00
|
|
|
}
|
|
|
|
|
2021-11-22 18:05:09 +00:00
|
|
|
endpointGroups, err := handler.dataStore.EndpointGroup().EndpointGroups()
|
2021-08-05 03:02:06 +00:00
|
|
|
if err != nil {
|
2021-11-22 18:05:09 +00:00
|
|
|
return nil, &httperror.HandlerError{http.StatusInternalServerError, "Unable to retrieve environment groups from the database", err}
|
2021-08-05 03:02:06 +00:00
|
|
|
}
|
|
|
|
|
2021-11-22 18:05:09 +00:00
|
|
|
if len(endpointIDs) > 0 {
|
|
|
|
var endpoints []portainer.Endpoint
|
|
|
|
for _, endpointID := range endpointIDs {
|
|
|
|
endpoint, err := handler.dataStore.Endpoint().Endpoint(endpointID)
|
|
|
|
if err != nil {
|
|
|
|
return nil, &httperror.HandlerError{http.StatusInternalServerError, "Unable to retrieve environment from the database", err}
|
|
|
|
}
|
|
|
|
if !endpointutils.IsKubernetesEndpoint(endpoint) {
|
|
|
|
continue
|
|
|
|
}
|
|
|
|
endpoints = append(endpoints, *endpoint)
|
|
|
|
}
|
|
|
|
filteredEndpoints := security.FilterEndpoints(endpoints, endpointGroups, securityContext)
|
|
|
|
return filteredEndpoints, nil
|
|
|
|
}
|
2021-08-05 03:02:06 +00:00
|
|
|
|
2021-11-22 18:05:09 +00:00
|
|
|
var kubeEndpoints []portainer.Endpoint
|
|
|
|
endpoints, err := handler.dataStore.Endpoint().Endpoints()
|
2021-08-05 03:02:06 +00:00
|
|
|
if err != nil {
|
2021-11-22 18:05:09 +00:00
|
|
|
return nil, &httperror.HandlerError{http.StatusInternalServerError, "Unable to retrieve environments from the database", err}
|
|
|
|
}
|
|
|
|
for _, endpoint := range endpoints {
|
|
|
|
if !endpointutils.IsKubernetesEndpoint(&endpoint) {
|
|
|
|
continue
|
|
|
|
}
|
|
|
|
kubeEndpoints = append(kubeEndpoints, endpoint)
|
2021-08-05 03:02:06 +00:00
|
|
|
}
|
|
|
|
|
2021-11-22 18:05:09 +00:00
|
|
|
filteredEndpoints := security.FilterEndpoints(kubeEndpoints, endpointGroups, securityContext)
|
|
|
|
if len(excludeEndpointIDs) > 0 {
|
|
|
|
filteredEndpoints = endpointutils.FilterByExcludeIDs(filteredEndpoints, excludeEndpointIDs)
|
|
|
|
}
|
|
|
|
return filteredEndpoints, nil
|
|
|
|
}
|
|
|
|
|
|
|
|
func (handler *Handler) buildConfig(r *http.Request, tokenData *portainer.TokenData, bearerToken string, endpoints []portainer.Endpoint) (*clientV1.Config, *httperror.HandlerError) {
|
|
|
|
configClusters := make([]clientV1.NamedCluster, len(endpoints))
|
|
|
|
configContexts := make([]clientV1.NamedContext, len(endpoints))
|
|
|
|
var configAuthInfos []clientV1.NamedAuthInfo
|
|
|
|
authInfosSet := make(map[string]bool)
|
|
|
|
|
|
|
|
for idx, endpoint := range endpoints {
|
2021-12-06 21:40:59 +00:00
|
|
|
instanceID := handler.kubernetesClientFactory.GetInstanceID()
|
|
|
|
serviceAccountName := kcli.UserServiceAccountName(int(tokenData.ID), instanceID)
|
2021-11-22 18:05:09 +00:00
|
|
|
|
2022-03-21 12:51:29 +00:00
|
|
|
configClusters[idx] = handler.buildCluster(r, endpoint)
|
2021-12-06 21:40:59 +00:00
|
|
|
configContexts[idx] = buildContext(serviceAccountName, endpoint)
|
|
|
|
if !authInfosSet[serviceAccountName] {
|
|
|
|
configAuthInfos = append(configAuthInfos, buildAuthInfo(serviceAccountName, bearerToken))
|
|
|
|
authInfosSet[serviceAccountName] = true
|
2021-11-22 18:05:09 +00:00
|
|
|
}
|
2021-08-05 03:02:06 +00:00
|
|
|
}
|
|
|
|
|
2021-11-22 18:05:09 +00:00
|
|
|
return &clientV1.Config{
|
|
|
|
APIVersion: "v1",
|
|
|
|
Kind: "Config",
|
|
|
|
Clusters: configClusters,
|
|
|
|
Contexts: configContexts,
|
|
|
|
CurrentContext: configContexts[0].Name,
|
|
|
|
AuthInfos: configAuthInfos,
|
|
|
|
}, nil
|
2021-08-05 03:02:06 +00:00
|
|
|
}
|
|
|
|
|
2022-03-21 12:51:29 +00:00
|
|
|
func (handler *Handler) buildCluster(r *http.Request, endpoint portainer.Endpoint) clientV1.NamedCluster {
|
2022-07-21 04:59:40 +00:00
|
|
|
kubeConfigInternal := handler.kubeClusterAccessService.GetData(r.Host, endpoint.ID)
|
2021-11-22 18:05:09 +00:00
|
|
|
return clientV1.NamedCluster{
|
|
|
|
Name: buildClusterName(endpoint.Name),
|
|
|
|
Cluster: clientV1.Cluster{
|
2022-03-21 12:51:29 +00:00
|
|
|
Server: kubeConfigInternal.ClusterServerURL,
|
2021-11-22 18:05:09 +00:00
|
|
|
InsecureSkipTLSVerify: true,
|
|
|
|
},
|
|
|
|
}
|
2021-08-05 03:02:06 +00:00
|
|
|
}
|
|
|
|
|
2021-11-22 18:05:09 +00:00
|
|
|
func buildClusterName(endpointName string) string {
|
|
|
|
return fmt.Sprintf("portainer-cluster-%s", endpointName)
|
|
|
|
}
|
|
|
|
|
|
|
|
func buildContext(serviceAccountName string, endpoint portainer.Endpoint) clientV1.NamedContext {
|
|
|
|
contextName := fmt.Sprintf("portainer-ctx-%s", endpoint.Name)
|
|
|
|
return clientV1.NamedContext{
|
|
|
|
Name: contextName,
|
|
|
|
Context: clientV1.Context{
|
|
|
|
AuthInfo: serviceAccountName,
|
|
|
|
Cluster: buildClusterName(endpoint.Name),
|
|
|
|
},
|
2021-08-05 03:02:06 +00:00
|
|
|
}
|
2021-11-22 18:05:09 +00:00
|
|
|
}
|
2021-08-05 03:02:06 +00:00
|
|
|
|
2021-11-22 18:05:09 +00:00
|
|
|
func buildAuthInfo(serviceAccountName string, bearerToken string) clientV1.NamedAuthInfo {
|
|
|
|
return clientV1.NamedAuthInfo{
|
|
|
|
Name: serviceAccountName,
|
|
|
|
AuthInfo: clientV1.AuthInfo{
|
|
|
|
Token: bearerToken,
|
|
|
|
},
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
func writeFileContent(w http.ResponseWriter, r *http.Request, endpoints []portainer.Endpoint, tokenData *portainer.TokenData, config *clientV1.Config) *httperror.HandlerError {
|
|
|
|
filenameSuffix := "kubeconfig"
|
|
|
|
if len(endpoints) == 1 {
|
|
|
|
filenameSuffix = endpoints[0].Name
|
|
|
|
}
|
|
|
|
filenameBase := fmt.Sprintf("%s-%s", tokenData.Username, filenameSuffix)
|
2021-08-05 03:02:06 +00:00
|
|
|
|
2021-11-22 18:05:09 +00:00
|
|
|
if r.Header.Get("Accept") == "text/yaml" {
|
|
|
|
yaml, err := kcli.GenerateYAML(config)
|
|
|
|
if err != nil {
|
|
|
|
return &httperror.HandlerError{http.StatusInternalServerError, "Failed to generate Kubeconfig", err}
|
|
|
|
}
|
|
|
|
|
|
|
|
w.Header().Set("Content-Disposition", fmt.Sprintf("attachment; %s.yaml", filenameBase))
|
|
|
|
return response.YAML(w, yaml)
|
|
|
|
}
|
|
|
|
|
|
|
|
w.Header().Set("Content-Disposition", fmt.Sprintf("attachment; %s.json", filenameBase))
|
|
|
|
return response.JSON(w, config)
|
2021-08-05 03:02:06 +00:00
|
|
|
}
|