Deployment Environment Config

This page describes spec.spinnakerConfig.config.deploymentEnvironment config variables such as Clouddriver High Availability (HA), Echo HA, sidecars, init containers (initContainers), and hostAliases.

deploymentEnvironment

deploymentEnvironment:
  size:
  type:
  accountName:
  imageVariant:
  bootstrapOnly:
  updateVersions:
  consul:
    enabled:
    address:
  vault:
    enabled:
    address:
  location:
  customSizing:
    clouddriver:
      replicas:
      requests:
        memory:
        cpu:
      limits:
        memory:
        cpu:
  sidecars:
    clouddriver:
    - name:
      dockerImage:
      port:
      env:
    abc:
      args:
      - arg1
      command:
      - arg1
      configMapVolumeMounts:
      - configMapName:
    mountPath:
      secretVolumeMounts:
      - secretName:
    mountPath:
      mountPath:
      securityContext:
    privileged:
  initContainers: {}
  hostAliases: {}
  nodeSelectors:
    abc:
  affinity: {}
  tolerations:
    clouddriver:
    - key:
      operator:
      value:
      effect:
  gitConfig:
    upstreamUser:
    originUser:
  livenessProbeConfig:
    enabled:
    initialDelaySeconds:
  haServices:
    clouddriver:
      enabled:
      disableClouddriverRoDeck:
      redisMasterEndpoint:
      redisSlaveEndpoint:
      redisSlaveDeckEndpoint:
    echo:
      enabled:
  • size: SMALL
  • type: Distributed, LocalDebian, or LocalGit; Distributed: Deploy Spinnaker with one server group per microservice, and a single shared Redis. LocalDebian: Download and run the Spinnaker debians on the machine running the Daemon. LocalGit: Download and run the Spinnaker git repos on the machine running the Daemon.
  • accountName: The Spinnaker account that Spinnaker will be deployed to, assuming you are running a deployment of Spinnaker that requires an active cloud provider.
  • imageVariant: The container image variant type to use when deploying a distributed installation of Spinnaker. SLIM: Based on an Alpine image ubuntu: Based on Canonical’s ubuntu:bionic image. JAVA8: A variant of slim that uses the Java 8 runtime. UBUNTU-JAVA8: A variant of ubuntu that uses the Java 8 runtime Default value: SLIM
  • bootstrapOnly: true or false; a bootstrap-only account is the account in which Spinnaker itself is deployed. When true, this account will not be included the accounts managed by Spinnaker.
  • updateVersions: true or false; when set to “false”, any local version of Spinnaker components will be used instead of attempting to update. This does not work for distributed installations of Spinnaker, where no local version exists.
  • consul:
    • enabled: true or false; whether or not to use Consul as a service discovery mechanism to deploy Spinnaker.
    • address: The address of a running Consul cluster. This is only required when Spinnaker is being deployed in non-Kubernetes clustered configuration.
  • vault:
    • enabled: true or false; whether or not to use Vault as a secret storage mechanism to deploy Spinnaker.
    • address: The address of a running Vault datastore. This is only required when Spinnaker is being deployed in non-Kubernetes clustered configuration.
  • location: This is the location spinnaker will be deployed to. When deploying to Kubernetes, use this flag to specify the namespace to deploy to (defaults to spinnaker)
  • customSizing: Configure, validate, and view the component sizings for the Spinnaker services. Example above only lists clouddriver as an option, but other services can be defined, e.g. echo. Note that if you want to define the sizing for the entire service including sidecars, the definition should be in the spin-$SERVICE format. If only the main container should be defined, use $SERVICE for the definition instead.
    • spin-clouddriver:
      • replicas: Set the number of replicas (pods) to be created for this service.
      • requests:
        • memory: Sets the memory request for the container running the spinnaker service. Examples: 512Mi, 8Gi
        • cpu: Sets the cpu request for the container running the spinnaker service. Example: 250m.
    • limits:
      • memory: example: 8Gi
      • cpu: example: 250m
  • sidecars:
    • clouddriver:
      • name:
      • dockerImage:
      • port:
      • env:
        • key: definition
      • args:
        • arg1
      • command:
        • arg1
      • configMapVolumeMounts:
        • configMapName:
        • mountPath:
      • secretVolumeMounts:
        • secretName:
        • mountPath:
      • mountPath:
      • securityContext:
        • privileged: true or false.
  • initContainers: {}
  • hostAliases: {}
  • nodeSelectors:
    • key: definition
  • affinity: {}
  • tolerations:
    • clouddriver:`
      • key:
      • operator: Exists, Equal, or DoesNotExist
      • value:
      • effect:
  • gitConfig:
    • upstreamUser: This is the upstream git user you are configuring to pull changes from & push PRs to.
    • originUser: This is the git user your github fork exists under.
  • livenessProbeConfig:
    • enabled: true or false; when true, enable Kubernetes liveness probes on Spinnaker services deployed in a Distributed installation. See docs for more information.
    • initialDelaySeconds: The number of seconds to wait before performing the first liveness probe. Should be set to the longest service startup time. See docs for more information.
  • haServices:
    • clouddriver:
      • enabled: true or false.
      • disableClouddriverRoDeck: true or false.
      • redisMasterEndpoint: Set external Redis endpoint for clouddriver-rw and clouddriver-caching. The Redis URI schema is described here. clouddriver-rw and clouddriver-caching are configured to use the shared Redis, by default.
      • redisSlaveEndpoint: Set external Redis endpoint for clouddriver-ro. The Redis URI schema is described here. clouddriver-ro is configured to use the shared Redis, by default.
      • redisSlaveDeckEndpoint: Set external Redis endpoint for clouddriver-ro-deck. The Redis URI schema is described here. clouddriver-ro-deck is configured to use the shared Redis, by default.
    • echo:
      • enabled: true or false.

Kustomize patch examples

You can see examples in the spinnaker-kustomize-patches repo’s spinnaker_deployment folder.


Last modified November 2, 2023: (af1c74ee)