2020-02-21 13:56:09 +02:00
// Code generated by piper's step-generator. DO NOT EDIT.
2020-01-24 15:30:27 +02:00
package cmd
import (
2020-01-31 15:06:08 +02:00
"fmt"
2020-01-24 15:30:27 +02:00
"os"
2020-01-31 15:06:08 +02:00
"time"
2020-01-24 15:30:27 +02:00
"github.com/SAP/jenkins-library/pkg/config"
"github.com/SAP/jenkins-library/pkg/log"
2020-01-29 14:17:54 +02:00
"github.com/SAP/jenkins-library/pkg/telemetry"
2020-01-24 15:30:27 +02:00
"github.com/spf13/cobra"
)
type kubernetesDeployOptions struct {
AdditionalParameters [ ] string ` json:"additionalParameters,omitempty" `
APIServer string ` json:"apiServer,omitempty" `
AppTemplate string ` json:"appTemplate,omitempty" `
ChartPath string ` json:"chartPath,omitempty" `
ContainerRegistryPassword string ` json:"containerRegistryPassword,omitempty" `
ContainerRegistryURL string ` json:"containerRegistryUrl,omitempty" `
ContainerRegistryUser string ` json:"containerRegistryUser,omitempty" `
ContainerRegistrySecret string ` json:"containerRegistrySecret,omitempty" `
CreateDockerRegistrySecret bool ` json:"createDockerRegistrySecret,omitempty" `
DeploymentName string ` json:"deploymentName,omitempty" `
DeployTool string ` json:"deployTool,omitempty" `
HelmDeployWaitSeconds int ` json:"helmDeployWaitSeconds,omitempty" `
2020-08-18 07:32:36 +02:00
HelmValues [ ] string ` json:"helmValues,omitempty" `
2020-01-24 15:30:27 +02:00
Image string ` json:"image,omitempty" `
IngressHosts [ ] string ` json:"ingressHosts,omitempty" `
KubeConfig string ` json:"kubeConfig,omitempty" `
KubeContext string ` json:"kubeContext,omitempty" `
KubeToken string ` json:"kubeToken,omitempty" `
Namespace string ` json:"namespace,omitempty" `
TillerNamespace string ` json:"tillerNamespace,omitempty" `
}
// KubernetesDeployCommand Deployment to Kubernetes test or production namespace within the specified Kubernetes cluster.
func KubernetesDeployCommand ( ) * cobra . Command {
2020-04-28 07:42:02 +02:00
const STEP_NAME = "kubernetesDeploy"
2020-01-24 15:30:27 +02:00
metadata := kubernetesDeployMetadata ( )
2020-02-04 11:46:43 +02:00
var stepConfig kubernetesDeployOptions
2020-01-31 15:06:08 +02:00
var startTime time . Time
2020-01-24 15:30:27 +02:00
var createKubernetesDeployCmd = & cobra . Command {
2020-04-28 07:42:02 +02:00
Use : STEP_NAME ,
2020-01-24 15:30:27 +02:00
Short : "Deployment to Kubernetes test or production namespace within the specified Kubernetes cluster." ,
Long : ` Deployment to Kubernetes test or production namespace within the specified Kubernetes cluster .
! ! ! note "Deployment supports multiple deployment tools"
Currently the following are supported :
* [ Helm ] ( https : //helm.sh/) command line tool and [Helm Charts](https://docs.helm.sh/developing_charts/#charts).
* [ kubectl ] ( https : //kubernetes.io/docs/reference/kubectl/overview/) and ` + "`" + `kubectl apply` + "`" + ` command.
# # Helm
Following helm command will be executed by default :
` + " ` " + `` + " ` " + ` ` + " ` " + `
helm upgrade < deploymentName > < chartPath > -- install -- force -- namespace < namespace > -- wait -- timeout < helmDeployWaitSeconds > -- set " image . repository = < yourRegistry > / < yourImageName > , image . tag = < yourImageTag > , secret . dockerconfigjson = < dockerSecret > , ingress . hosts [ 0 ] = < ingressHosts [ 0 ] > , , ingress . hosts [ 1 ] = < ingressHosts [ 1 ] > , ...
` + " ` " + `` + " ` " + ` ` + " ` " + `
* ` + " ` " + `yourRegistry` + " ` " + ` will be retrieved from ` + " ` " + `containerRegistryUrl` + " ` " + `
* ` + " ` " + `yourImageName` + " ` " + ` , ` + " ` " + `yourImageTag` + " ` " + ` will be retrieved from ` + " ` " + `image` + " ` " + `
* ` + " ` " + `dockerSecret` + " ` " + ` will be calculated with a call to ` + " ` " + `kubectl create secret docker-registry regsecret --docker-server=<yourRegistry> --docker-username=<containerRegistryUser> --docker-password=<containerRegistryPassword> --dry-run=true --output=json'` + " ` " + ` ` ,
2020-06-23 18:05:21 +02:00
PreRunE : func ( cmd * cobra . Command , _ [ ] string ) error {
2020-01-31 15:06:08 +02:00
startTime = time . Now ( )
2020-04-28 07:42:02 +02:00
log . SetStepName ( STEP_NAME )
2020-01-24 15:30:27 +02:00
log . SetVerbose ( GeneralConfig . Verbose )
2020-04-28 07:42:02 +02:00
path , _ := os . Getwd ( )
fatalHook := & log . FatalHook { CorrelationID : GeneralConfig . CorrelationID , Path : path }
log . RegisterHook ( fatalHook )
err := PrepareConfig ( cmd , & metadata , STEP_NAME , & stepConfig , config . OpenPiperFile )
2020-04-16 14:37:45 +02:00
if err != nil {
2020-06-24 10:04:05 +02:00
log . SetErrorCategory ( log . ErrorConfiguration )
2020-04-16 14:37:45 +02:00
return err
}
log . RegisterSecret ( stepConfig . ContainerRegistryPassword )
log . RegisterSecret ( stepConfig . ContainerRegistryUser )
2020-08-28 15:38:15 +02:00
log . RegisterSecret ( stepConfig . KubeConfig )
2020-04-16 14:37:45 +02:00
log . RegisterSecret ( stepConfig . KubeToken )
2020-05-05 08:36:24 +02:00
if len ( GeneralConfig . HookConfig . SentryConfig . Dsn ) > 0 {
sentryHook := log . NewSentryHook ( GeneralConfig . HookConfig . SentryConfig . Dsn , GeneralConfig . CorrelationID )
log . RegisterHook ( & sentryHook )
}
2020-04-16 14:37:45 +02:00
return nil
2020-01-24 15:30:27 +02:00
} ,
2020-06-23 18:05:21 +02:00
Run : func ( _ * cobra . Command , _ [ ] string ) {
2020-01-31 15:06:08 +02:00
telemetryData := telemetry . CustomData { }
telemetryData . ErrorCode = "1"
handler := func ( ) {
telemetryData . Duration = fmt . Sprintf ( "%v" , time . Since ( startTime ) . Milliseconds ( ) )
telemetry . Send ( & telemetryData )
}
log . DeferExitHandler ( handler )
defer handler ( )
2020-04-28 07:42:02 +02:00
telemetry . Initialize ( GeneralConfig . NoTelemetry , STEP_NAME )
2020-02-04 11:46:43 +02:00
kubernetesDeploy ( stepConfig , & telemetryData )
2020-01-31 15:06:08 +02:00
telemetryData . ErrorCode = "0"
2020-05-18 21:52:54 +02:00
log . Entry ( ) . Info ( "SUCCESS" )
2020-01-24 15:30:27 +02:00
} ,
}
2020-02-04 11:46:43 +02:00
addKubernetesDeployFlags ( createKubernetesDeployCmd , & stepConfig )
2020-01-24 15:30:27 +02:00
return createKubernetesDeployCmd
}
2020-02-04 11:46:43 +02:00
func addKubernetesDeployFlags ( cmd * cobra . Command , stepConfig * kubernetesDeployOptions ) {
cmd . Flags ( ) . StringSliceVar ( & stepConfig . AdditionalParameters , "additionalParameters" , [ ] string { } , "Defines additional parameters for \"helm install\" or \"kubectl apply\" command." )
cmd . Flags ( ) . StringVar ( & stepConfig . APIServer , "apiServer" , os . Getenv ( "PIPER_apiServer" ) , "Defines the Url of the API Server of the Kubernetes cluster." )
cmd . Flags ( ) . StringVar ( & stepConfig . AppTemplate , "appTemplate" , os . Getenv ( "PIPER_appTemplate" ) , "Defines the filename for the kubernetes app template (e.g. k8s_apptemplate.yaml)" )
cmd . Flags ( ) . StringVar ( & stepConfig . ChartPath , "chartPath" , os . Getenv ( "PIPER_chartPath" ) , "Defines the chart path for deployments using helm." )
cmd . Flags ( ) . StringVar ( & stepConfig . ContainerRegistryPassword , "containerRegistryPassword" , os . Getenv ( "PIPER_containerRegistryPassword" ) , "Password for container registry access - typically provided by the CI/CD environment." )
2020-07-29 15:48:55 +02:00
cmd . Flags ( ) . StringVar ( & stepConfig . ContainerRegistryURL , "containerRegistryUrl" , os . Getenv ( "PIPER_containerRegistryUrl" ) , "http(s) url of the Container registry where the image to deploy is located." )
2020-02-04 11:46:43 +02:00
cmd . Flags ( ) . StringVar ( & stepConfig . ContainerRegistryUser , "containerRegistryUser" , os . Getenv ( "PIPER_containerRegistryUser" ) , "Username for container registry access - typically provided by the CI/CD environment." )
2020-05-25 19:48:59 +02:00
cmd . Flags ( ) . StringVar ( & stepConfig . ContainerRegistrySecret , "containerRegistrySecret" , ` regsecret ` , "Name of the container registry secret used for pulling containers from the registry." )
2020-08-18 07:32:36 +02:00
cmd . Flags ( ) . BoolVar ( & stepConfig . CreateDockerRegistrySecret , "createDockerRegistrySecret" , false , "Only for `deployTool:kubectl`: Toggle to turn on `containerRegistrySecret` creation." )
2020-02-04 11:46:43 +02:00
cmd . Flags ( ) . StringVar ( & stepConfig . DeploymentName , "deploymentName" , os . Getenv ( "PIPER_deploymentName" ) , "Defines the name of the deployment." )
2020-05-25 19:48:59 +02:00
cmd . Flags ( ) . StringVar ( & stepConfig . DeployTool , "deployTool" , ` kubectl ` , "Defines the tool which should be used for deployment." )
2020-02-04 11:46:43 +02:00
cmd . Flags ( ) . IntVar ( & stepConfig . HelmDeployWaitSeconds , "helmDeployWaitSeconds" , 300 , "Number of seconds before helm deploy returns." )
2020-08-18 07:32:36 +02:00
cmd . Flags ( ) . StringSliceVar ( & stepConfig . HelmValues , "helmValues" , [ ] string { } , "List of helm values as YAML file reference or URL (as per helm parameter description for `-f` / `--values`)" )
2020-02-04 11:46:43 +02:00
cmd . Flags ( ) . StringVar ( & stepConfig . Image , "image" , os . Getenv ( "PIPER_image" ) , "Full name of the image to be deployed." )
2020-08-18 07:32:36 +02:00
cmd . Flags ( ) . StringSliceVar ( & stepConfig . IngressHosts , "ingressHosts" , [ ] string { } , "(Deprecated) List of ingress hosts to be exposed via helm deployment." )
2020-02-04 11:46:43 +02:00
cmd . Flags ( ) . StringVar ( & stepConfig . KubeConfig , "kubeConfig" , os . Getenv ( "PIPER_kubeConfig" ) , "Defines the path to the \"kubeconfig\" file." )
cmd . Flags ( ) . StringVar ( & stepConfig . KubeContext , "kubeContext" , os . Getenv ( "PIPER_kubeContext" ) , "Defines the context to use from the \"kubeconfig\" file." )
cmd . Flags ( ) . StringVar ( & stepConfig . KubeToken , "kubeToken" , os . Getenv ( "PIPER_kubeToken" ) , "Contains the id_token used by kubectl for authentication. Consider using kubeConfig parameter instead." )
2020-05-25 19:48:59 +02:00
cmd . Flags ( ) . StringVar ( & stepConfig . Namespace , "namespace" , ` default ` , "Defines the target Kubernetes namespace for the deployment." )
2020-02-04 11:46:43 +02:00
cmd . Flags ( ) . StringVar ( & stepConfig . TillerNamespace , "tillerNamespace" , os . Getenv ( "PIPER_tillerNamespace" ) , "Defines optional tiller namespace for deployments using helm." )
2020-01-24 15:30:27 +02:00
cmd . MarkFlagRequired ( "chartPath" )
cmd . MarkFlagRequired ( "containerRegistryUrl" )
cmd . MarkFlagRequired ( "deploymentName" )
cmd . MarkFlagRequired ( "deployTool" )
cmd . MarkFlagRequired ( "image" )
}
// retrieve step metadata
func kubernetesDeployMetadata ( ) config . StepData {
var theMetaData = config . StepData {
2020-03-19 18:24:35 +02:00
Metadata : config . StepMetadata {
Name : "kubernetesDeploy" ,
2020-07-29 11:21:32 +02:00
Aliases : [ ] config . Alias { { Name : "deployToKubernetes" , Deprecated : true } } ,
2020-03-19 18:24:35 +02:00
} ,
2020-01-24 15:30:27 +02:00
Spec : config . StepSpec {
Inputs : config . StepInputs {
Parameters : [ ] config . StepParameters {
{
Name : "additionalParameters" ,
ResourceRef : [ ] config . ResourceReference { } ,
Scope : [ ] string { "PARAMETERS" , "STAGES" , "STEPS" } ,
Type : "[]string" ,
Mandatory : false ,
Aliases : [ ] config . Alias { { Name : "helmDeploymentParameters" } } ,
} ,
{
Name : "apiServer" ,
ResourceRef : [ ] config . ResourceReference { } ,
Scope : [ ] string { "GENERAL" , "PARAMETERS" , "STAGES" , "STEPS" } ,
Type : "string" ,
Mandatory : false ,
Aliases : [ ] config . Alias { { Name : "k8sAPIServer" } } ,
} ,
{
Name : "appTemplate" ,
ResourceRef : [ ] config . ResourceReference { } ,
Scope : [ ] string { "PARAMETERS" , "STAGES" , "STEPS" } ,
Type : "string" ,
Mandatory : false ,
Aliases : [ ] config . Alias { { Name : "k8sAppTemplate" } } ,
} ,
{
Name : "chartPath" ,
ResourceRef : [ ] config . ResourceReference { } ,
Scope : [ ] string { "PARAMETERS" , "STAGES" , "STEPS" } ,
Type : "string" ,
Mandatory : true ,
Aliases : [ ] config . Alias { { Name : "helmChartPath" } } ,
} ,
{
2020-09-16 14:50:09 +02:00
Name : "containerRegistryPassword" ,
ResourceRef : [ ] config . ResourceReference {
{
Name : "dockerCredentialsId" ,
Param : "password" ,
Type : "secret" ,
} ,
} ,
Scope : [ ] string { "PARAMETERS" , "STAGES" , "STEPS" } ,
Type : "string" ,
Mandatory : false ,
Aliases : [ ] config . Alias { } ,
2020-01-24 15:30:27 +02:00
} ,
{
2020-09-16 14:50:09 +02:00
Name : "containerRegistryUrl" ,
ResourceRef : [ ] config . ResourceReference {
{
Name : "commonPipelineEnvironment" ,
Param : "container/registryUrl" ,
} ,
} ,
Scope : [ ] string { "GENERAL" , "PARAMETERS" , "STAGES" , "STEPS" } ,
Type : "string" ,
Mandatory : true ,
Aliases : [ ] config . Alias { { Name : "dockerRegistryUrl" } } ,
2020-01-24 15:30:27 +02:00
} ,
{
2020-09-16 14:50:09 +02:00
Name : "containerRegistryUser" ,
ResourceRef : [ ] config . ResourceReference {
{
Name : "dockerCredentialsId" ,
Param : "username" ,
Type : "secret" ,
} ,
} ,
Scope : [ ] string { "PARAMETERS" , "STAGES" , "STEPS" } ,
Type : "string" ,
Mandatory : false ,
Aliases : [ ] config . Alias { } ,
2020-01-24 15:30:27 +02:00
} ,
{
Name : "containerRegistrySecret" ,
ResourceRef : [ ] config . ResourceReference { } ,
Scope : [ ] string { "PARAMETERS" , "STAGES" , "STEPS" } ,
Type : "string" ,
Mandatory : false ,
Aliases : [ ] config . Alias { } ,
} ,
{
Name : "createDockerRegistrySecret" ,
ResourceRef : [ ] config . ResourceReference { } ,
Scope : [ ] string { "PARAMETERS" , "STAGES" , "STEPS" } ,
Type : "bool" ,
Mandatory : false ,
Aliases : [ ] config . Alias { } ,
} ,
{
Name : "deploymentName" ,
ResourceRef : [ ] config . ResourceReference { } ,
Scope : [ ] string { "PARAMETERS" , "STAGES" , "STEPS" } ,
Type : "string" ,
Mandatory : true ,
Aliases : [ ] config . Alias { { Name : "helmDeploymentName" } } ,
} ,
{
Name : "deployTool" ,
ResourceRef : [ ] config . ResourceReference { } ,
Scope : [ ] string { "PARAMETERS" , "STAGES" , "STEPS" } ,
Type : "string" ,
Mandatory : true ,
Aliases : [ ] config . Alias { } ,
} ,
{
Name : "helmDeployWaitSeconds" ,
ResourceRef : [ ] config . ResourceReference { } ,
Scope : [ ] string { "PARAMETERS" , "STAGES" , "STEPS" } ,
Type : "int" ,
Mandatory : false ,
Aliases : [ ] config . Alias { } ,
2020-08-18 07:32:36 +02:00
} ,
{
Name : "helmValues" ,
ResourceRef : [ ] config . ResourceReference { } ,
Scope : [ ] string { "PARAMETERS" , "STAGES" , "STEPS" } ,
Type : "[]string" ,
Mandatory : false ,
Aliases : [ ] config . Alias { } ,
2020-01-24 15:30:27 +02:00
} ,
{
2020-09-16 14:50:09 +02:00
Name : "image" ,
ResourceRef : [ ] config . ResourceReference {
{
Name : "commonPipelineEnvironment" ,
Param : "container/imageNameTag" ,
} ,
} ,
Scope : [ ] string { "PARAMETERS" , "STAGES" , "STEPS" } ,
Type : "string" ,
Mandatory : true ,
Aliases : [ ] config . Alias { { Name : "deployImage" } } ,
2020-01-24 15:30:27 +02:00
} ,
{
Name : "ingressHosts" ,
ResourceRef : [ ] config . ResourceReference { } ,
Scope : [ ] string { "PARAMETERS" , "STAGES" , "STEPS" } ,
Type : "[]string" ,
Mandatory : false ,
Aliases : [ ] config . Alias { } ,
} ,
{
2020-09-16 14:50:09 +02:00
Name : "kubeConfig" ,
ResourceRef : [ ] config . ResourceReference {
{
Name : "kubeConfigFileCredentialsId" ,
Type : "secret" ,
} ,
} ,
Scope : [ ] string { "GENERAL" , "PARAMETERS" , "STAGES" , "STEPS" } ,
Type : "string" ,
Mandatory : false ,
Aliases : [ ] config . Alias { } ,
2020-01-24 15:30:27 +02:00
} ,
{
Name : "kubeContext" ,
ResourceRef : [ ] config . ResourceReference { } ,
Scope : [ ] string { "PARAMETERS" , "STAGES" , "STEPS" } ,
Type : "string" ,
Mandatory : false ,
Aliases : [ ] config . Alias { } ,
} ,
{
2020-09-16 14:50:09 +02:00
Name : "kubeToken" ,
ResourceRef : [ ] config . ResourceReference {
{
Name : "kubeTokenCredentialsId" ,
Type : "secret" ,
} ,
} ,
Scope : [ ] string { "GENERAL" , "PARAMETERS" , "STAGES" , "STEPS" } ,
Type : "string" ,
Mandatory : false ,
Aliases : [ ] config . Alias { } ,
2020-01-24 15:30:27 +02:00
} ,
{
Name : "namespace" ,
ResourceRef : [ ] config . ResourceReference { } ,
Scope : [ ] string { "PARAMETERS" , "STAGES" , "STEPS" } ,
Type : "string" ,
Mandatory : false ,
Aliases : [ ] config . Alias { { Name : "helmDeploymentNamespace" } , { Name : "k8sDeploymentNamespace" } } ,
} ,
{
Name : "tillerNamespace" ,
ResourceRef : [ ] config . ResourceReference { } ,
Scope : [ ] string { "PARAMETERS" , "STAGES" , "STEPS" } ,
Type : "string" ,
Mandatory : false ,
Aliases : [ ] config . Alias { { Name : "helmTillerNamespace" } } ,
} ,
} ,
} ,
} ,
}
return theMetaData
}