Install Operator and Deploy Armory Enterprise Quickstart

This guide is for both the Armory Operator and the Spinnaker Operator. Armory Enterprise and Spinnaker configuration is the same except for features only in Armory Enterprise. Those features are marked .

Before you begin

The goal of this guide is to deploy Armory Enterprise with bare minimum configuration. The What’s next section contains links to advanced configuration guides.

• You are familiar with Kubernetes Operators, which use custom resources to manage applications and their components.
• You understand the concept of managing Kubernetes resources using manifests.
• You have reviewed and met the Armory Enterprise system requirements.

Operator installation options

The Operator has basic and cluster installation modes. The option you use depends on which namespace you want to deploy Armory Enterprise or Spinnaker to.

Install the Operator

• Cluster Mode
• Basic Mode

Deploy an Armory Enterprise instance

Single manifest file option

• Armory Enterprise
• Spinnaker

apiVersion: spinnaker.armory.io/v1alpha2
kind: SpinnakerService
metadata:
  name: spinnaker
spec:
  spinnakerConfig:
    config:
      version: <version>   # the version of Armory Enterprise to deploy
      persistentStorage:
        persistentStoreType: s3
        s3:
          bucket: <change-me> # Armory Enterprise stores application and pipeline definitions here. Create an S3 bucket and provide the name here.
          rootFolder: front50
  # spec.expose - This section defines how Armory Enterprise should be publicly exposed
  expose:
    type: service  # Kubernetes LoadBalancer type (service/ingress), note: only "service" is supported for now
    service:
      type: LoadBalancer

kubectl -n spinnaker-operator apply -f deploy/spinnaker/basic/SpinnakerService.yml

apiVersion: spinnaker.io/v1alpha2
kind: SpinnakerService
metadata:
  name: spinnaker
spec:
  spinnakerConfig:
    config:
      version: <version>   # the version of Spinnaker to deploy
      persistentStorage:
        persistentStoreType: s3
        s3:
          bucket: <change-me> # Spinnaker stores application and pipeline definitions here. Create an S3 bucket and provide the name here.
          rootFolder: front50
  # spec.expose - This section defines how Spinnaker should be publicly exposed
  expose:
    type: service  # Kubernetes LoadBalancer type (service/ingress), note: only "service" is supported for now
    service:
      type: LoadBalancer

kubectl -n spinnaker-operator apply -f deploy/spinnaker/basic/spinnakerservice.yml

You can watch the installation progress by executing:

kubectl -n spinnaker-operator get spinsvc spinnaker -w

You can verify pod status by executing:

 kubectl -n spinnaker-operator get pods

The included manifest file is only for a very basic installation. Configure Armory Enterprise Using a Manifest File contains detailed manifest configuration options.

Kustomize patches option

This example assumes you deploy Armory Enterprise to the spinnaker-operator namespace.

Kustomize uses patch files to build a deployment file by overwriting sections of the spinnakerservice.yml manifest file. You declare your patch files in a kustomization.yml file, which kubectl and Kustomize and use to build the Armory Enterprise or Spinnaker manifest file.

You can put each manifest config section in its own file. For example, if you create a profiles-patch.yml patch with configuration for various services, you are telling Kustomize to overwrite the profiles section of the spinnakerservice.yml manifest with the contents of profiles-patch.yml. Kustomize is flexible, though, so you could instead create a separate patch file for each service (profiles-clouddriver-patch.yml, profiles-gate-patch.yml, profiles-deck-patch.yml, etc.), and then declare those patches in the kustomization.yml file.

Kustomize is part of kubectl, so you do not need to install Kustomize locally to build and verify your manifest file. You can run kubectl kustomize <path-to-kustomization.yml>. This prints out the contents of the manifest file that Kustomize builds using your kustomization.yml file.

kubectl versions up to and including v1.20 come bundled with Kustomize v2.0.3. kubectl 1.21 comes bundled with Kustomize v4.0.5. Using Kustomize patches has been tested with kubectl v1.19.x. and standalone Kustomize v2 and v3. You may see a panic error if you use the spinnaker-kustomize-patches repo with Kustomize v4.0+ or kubectl v1.21+.

For this quickstart, you can find bare minimum patches in /spinnaker-operator/deploy/spinnaker/kustomize. Before you deploy Armory Enterprise, you need to update the version and persistentStorage values in config-patch.yml.

The following example uses an AWS S3 bucket. You can find configuration for other storage types in the Persistent Storage reference.

This quickstart example is suitable for a proof of concept. For production environments, you should use a robust set of Kustomize patches. See the Configure Armory Enterprise Using Kustomize guide for details.

• Armory Enterprise
• Spinnaker

apiVersion: spinnaker.armory.io/v1alpha2
kind: SpinnakerService
metadata:
  name: spinnaker
spec:
  # spec.spinnakerConfig - This section is how to specify configuration spinnaker
  spinnakerConfig:
  # spec.spinnakerConfig.config - This section contains the contents of a deployment found in a halconfig .deploymentConfigurations[0]
    config:
      version: <version>  # the version of Armory Enterprise to be deployed
      persistentStorage:
        persistentStoreType: s3
        s3:
          bucket: mybucket
          rootFolder: front50

apiVersion: spinnaker.io/v1alpha2
kind: SpinnakerService
metadata:
  name: spinnaker
spec:
  # spec.spinnakerConfig - This section is how to specify configuration Spinnaker
  spinnakerConfig:
  # spec.spinnakerConfig.config - This section contains the contents of a deployment found in a halconfig .deploymentConfigurations[0]
    config:
      version: <version>  # the version of Spinnaker to be deployed
      persistentStorage:
        persistentStoreType: s3
        s3:
          bucket: mybucket
          rootFolder: front50

1. If you want to verify the contents of the manifest file, execute from the /spinnaker-operator/deploy/spinnaker/kustomize/ directory:

   kubectl kustomize .
   

   This prints out the contents of the manifest file that Kustomize built based on your kustomization.yml file.

2. Deploy from the /spinnaker-operator/deploy/spinnaker/kustomize/ directory:

   kubctl -n spinnaker-operator apply -k .
   

3. You can watch the installation progress by executing:

   kubectl -n spinnaker-operator get spinsvc spinnaker -w
   

4. You can verify pod status by executing:

   kubectl -n spinnaker-operator get pods
   

Help resources

• Armory Operator and Armory Enterprise: contact Armory Support or use the Spinnaker Slack #armory channel.
• Spinnaker Operator and Spinnaker: Spinnaker Slack #kubernetes-operator channel.

What’s next

• Learn how to Manage Armory Enterprise using the Operator.
• See advanced manifest configuration in the Configure Armory Enterprise Using a Manifest File guide.
• See advanced configuration using Kustomize in the Configure Armory Enterprise Using Kustomize guide.
• See the Errors and Troubleshooting guide if you encounter issues.
• If you are deploying Armory Enterprise, you may need to configure Halyard. See the Advanced Operator Configuration guide.
• Learn how to Manage Operator.