migrate.md

Migrating from Halyard to Operator

If you have a current Spinnaker instance installed via Halyard, use this guide to migrate existing configuration to Operator.

The migration process from Halyard to Operator can be completed in 7 steps:

1. To get started, install Spinnaker Operator.

2. Export Spinnaker configuration.

   Copy the desired profile's content from the config file

   For example, if you want to migrate the default hal profile, use the following SpinnakerService manifest structure:

   currentDeployment: default
   deploymentConfigurations:
   - name: default
     <CONTENT> 

   Add <CONTENT> in the spec.spinnakerConfig.config section in the SpinnakerService manifest as follows:

   spec:
     spinnakerConfig:
       config:
         <<CONTENT>> 

   Note: config is under ~/.hal

   More details on SpinnakerService Options on .spec.spinnakerConfig.config section

3. Export Spinnaker profiles.

   If you have configured Spinnaker profiles, you will need to migrate these profiles to the SpinnakerService manifest.

   First, identify the current profiles under ~/.hal/default/profiles

   For each file, create an entry under spec.spinnakerConfig.profiles

   For example, you have the following profile:

   $ ls -a ~/.hal/default/profiles | sort
   echo-local.yml

   Create a new entry with the name of the file without -local.yaml as follows:

   spec:
     spinnakerConfig:
       profiles:
         echo: 
           <CONTENT>

   More details on SpinnakerService Options on .spec.spinnakerConfig.profiles section

4. Export Spinnaker settings.

   If you configured Spinnaker settings, you need to migrate these settings to the SpinnakerService manifest also.

   First, identify the current settings under ~/.hal/default/service-settings

   For each file, create an entry under spec.spinnakerConfig.service-settings

   For example, you have the following settings:

   $ ls -a ~/.hal/default/service-settings | sort
   echo.yml

   Create a new entry with the name of the file without .yaml as follows:

   spec:
     spinnakerConfig:
       service-settings: 
         echo:
           <CONTENT>

   More details on SpinnakerService Options on .spec.spinnakerConfig.service-settings section

5. Export local file references.

   If you have references to local files in any part of the config, like kubeconfigFile, service account json files or others, you need to migrate these files to the SpinnakerService manifest.

   For each file, create an entry under spec.spinnakerConfig.files

   For example, you have a Kubernetes account configured like this:

   kubernetes:
     enabled: true
     accounts:
     - name: prod
       requiredGroupMembership: []
       providerVersion: V2
       permissions: {}
       dockerRegistries: []
       configureImagePullSecrets: true
       cacheThreads: 1
       namespaces: []
       omitNamespaces: []
       kinds: []
       omitKinds: []
       customResources: []
       cachingPolicies: []
       oAuthScopes: []
       onlySpinnakerManaged: false
       kubeconfigFile: /home/spinnaker/.hal/secrets/kubeconfig-prod
     primaryAccount: prod

   The kubeconfigFile field is a reference to a physical file on the machine running Halyard. You need to create a new entry in files section like this:

   spec:
     spinnakerConfig:
       files: 
         kubeconfig-prod: |
           <CONTENT>

   Then replace the file path in the config to match the key in the files section:

   kubernetes:
     enabled: true
     accounts:
     - name: prod
       requiredGroupMembership: []
       providerVersion: V2
       permissions: {}
       dockerRegistries: []
       configureImagePullSecrets: true
       cacheThreads: 1
       namespaces: []
       omitNamespaces: []
       kinds: []
       omitKinds: []
       customResources: []
       cachingPolicies: []
       oAuthScopes: []
       onlySpinnakerManaged: false
       kubeconfigFile: kubeconfig-prod  # File name must match "files" key
     primaryAccount: prod

   More details on SpinnakerService Options on .spec.spinnakerConfig.files section

6. Export Packer template files (if used).

   If you are using custom Packer templates for baking images, you need to migrate these files to the SpinnakerService manifest.

   First, identify the current templates under ~/.hal/default/profiles/rosco/packer

   For each file, reate an entry under spec.spinnakerConfig.files

   For example, you have the following example-packer-config file:

   $ tree -v ~/.hal/default/profiles
   ├── echo-local.yml
   └── rosco
       └── packer
           └── example-packer-config.json
   
   2 directories, 2 files

   You need to create a new entry with the name of the file following these instructions:

   • For each file, list the folder name starting with profiles, followed by double underscores (__) and at the very end the name of the file.

   spec:
     spinnakerConfig:
       files: 
         profiles__rosco__packer__example-packer-config.json: |
           <CONTENT>

   More details on SpinnakerService Options on .spec.spinnakerConfig.files section

7. Validate your Spinnaker configuration if you plan to run the Operator in cluster mode.

   $ kubectl -n <namespace> apply -f <spinnaker service manifest> --server-dry-run

   The validation service throws an error when something is wrong with your manifest.

8. Apply your SpinnakerService

   $ kubectl -n <namespace> apply -f <spinnaker service>