portainer/portainer

View on GitHub
api/http/handler/kubernetes/toggle_system.go

Summary

Maintainability
A
40 mins
Test Coverage
package kubernetes

import (
    "net/http"

    "github.com/portainer/portainer/api/http/middlewares"
    httperror "github.com/portainer/portainer/pkg/libhttp/error"
    "github.com/portainer/portainer/pkg/libhttp/request"
    "github.com/portainer/portainer/pkg/libhttp/response"
)

type namespacesToggleSystemPayload struct {
    // Toggle the system state of this namespace to true or false
    System bool `example:"true"`
}

func (payload *namespacesToggleSystemPayload) Validate(r *http.Request) error {
    return nil
}

// @id KubernetesNamespacesToggleSystem
// @summary Toggle the system state for a namespace
// @description  Toggle the system state for a namespace
// @description **Access policy**: administrator or environment(endpoint) admin
// @security ApiKeyAuth
// @security jwt
// @tags kubernetes
// @accept json
// @param id path int true "Environment(Endpoint) identifier"
// @param namespace path string true "Namespace name"
// @param body body namespacesToggleSystemPayload true "Update details"
// @success 200 "Success"
// @failure 400 "Invalid request"
// @failure 404 "Environment(Endpoint) not found"
// @failure 500 "Server error"
// @router /kubernetes/{id}/namespaces/{namespace}/system [put]
func (handler *Handler) namespacesToggleSystem(rw http.ResponseWriter, r *http.Request) *httperror.HandlerError {
    endpoint, err := middlewares.FetchEndpoint(r)
    if err != nil {
        return httperror.NotFound("Unable to find an environment on request context", err)
    }

    namespaceName, err := request.RetrieveRouteVariableValue(r, "namespace")
    if err != nil {
        return httperror.BadRequest("Invalid namespace identifier route variable", err)
    }

    var payload namespacesToggleSystemPayload
    err = request.DecodeAndValidateJSONPayload(r, &payload)
    if err != nil {
        return httperror.BadRequest("Invalid request payload", err)
    }

    kubeClient, err := handler.KubernetesClientFactory.GetKubeClient(endpoint)
    if err != nil {
        return httperror.InternalServerError("Unable to create kubernetes client", err)
    }

    err = kubeClient.ToggleSystemState(namespaceName, payload.System)
    if err != nil {
        return httperror.InternalServerError("Unable to toggle system status", err)
    }

    return response.Empty(rw)

}