Keel Setup Guide

Configuration required by Keel

1. MySQL installation reachable by Keel.
2. Keel service endpoint available to Orca, Echo, and Front50.
3. Enable feature flags in Deck
4. Enable Igor integration with SCM services

Adding keel to an existing Spinnaker installation

MySQL instance

Can be a cloud managed MySQL instance, an instance running in Kubernetes, or on a VM. It just needs to be rechable by Keel.

This is only needed if you would like to create the database manually:

CREATE DATABASE `keel` DEFAULT CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci;

GRANT
SELECT, INSERT, UPDATE, DELETE, CREATE, DROP, REFERENCES, INDEX, ALTER, LOCK TABLES, EXECUTE, SHOW VIEW, CREATE VIEW
ON `keel`.*
TO 'keel_service'@'%'; -- IDENTIFIED BY "password" if using password based auth

Keel service endpoint

Keel service endpoint must be known by other serivces. Usually service endpoint information is configured in /opt/spinnaker/config/spinnaker.yml for each service, but this can be added to <SERVICE>-local.yml as well. Add the following to one of yml files.

keel:
  baseUrl: http://keel:7010
  enabled: true

Note that the keel service must be reachable at keel on port 7010 for the above configuraiton to work. If this is not correct for your environment, be sure to update it.

Configure Deck

To display Managed Delivery features in UI, the following must be specified in settings-local.js file in Deck.

window.spinnakerSettings.feature.managedDelivery = true;
window.spinnakerSettings.feature.managedResources = true;

Configure Igor

Keel needs to be able to pull delivery configuration from a configured source. Consult this page for syntaxes. For example, if your delivery configuration will be hosted on Github, add the following to igor-local.yml or igor.yml.

github:
  baseUrl: "https://api.github.com"
  accessToken: <TOKEN>
  commitDisplayLength: 8

Consult this page for steps on generating Github tokens.

Configure Front50

Add the following to front50.yml or front50-local.yml.

spinnaker:
  delivery:
    enabled: true

Configure and run Keel

1. Build docker image
2. Create a configuration file for keel (keel.yml or keel-loca.yml):

keel:
  plugins:
    deliveryConfig:
      enabled: true
    ec2:
      enabled: true
    k8s:
      enabled: true # Only if you have the K8s plugin installed.
sql:
  connectionPools:
    default:
      jdbcUrl: jdbc:mysql://mysql/keel?useSSL=false
      password: mysecretpassword 
      user: keel
  enabled: true
  migration:
    jdbcUrl: jdbc:mysql://mysql/keel?useSSL=false
    password: mysecretpassword
    user: keel

3. Mount configuration files (/opt/spinnaker/config/{spinnaker.yml,keel.yml,keel-local.yml) and run /opt/keel/bin/keel
4. See Dockerfile.ubuntu and keel deployment file for an example.

New Spinnaker installation

Note

1. This setup assumes there is a namespace called keel and will install everything under that namespace.
2. Currently there is no official Keel Docker images available. Be sure to follow the Build docker image to build Keel Docker images. Then ensure the images are available to your Kubernetes cluster. Update the kustomization file to replace the image used by the keel deployment (us-docker.pkg.dev/spinnaker-community/docker/keel:spinnaker-master-latest-unvalidated)
3. This will create mysql and redis services.

Installation Steps

1. Install kleat and install kustomize
2. Create a namespace to deploy Spinnaker into: kubectl create ns keel Default is keel and can be changed in the kustomization file
3. Customize the halconfig.yml file for your own environment. It has a AWs account and two Kubernetes accounts. Be sure to disable accounts you don't want to use and update accounts you are going to use. For example, if you want to use an AWS account, update the account ID in halconfig.yml and ensure the AWS credentials file contains valid information. Similarly, if you would like to use kubernetes accounts, be sure to update the kubeconfig file.
4. Run kleat generate halconfig.yml spinnaker-config/base/kleat. This will generate configuration files for Spinnaker microservices and will replace files under spinnaker-config/base/kleat. Files under spinnaker-config/base/kleat are provided as reference only and meant to be replaced by configuration files generated by kleat.
5. Run kustomize build spinnaker-config/overlays/keel and examine the output. Ensure your customization took place.
6. If everything looks good, run kustomize build spinnaker-config/overlays/keel | kubectl apply -f -

Keel usage

Follow this guide for quick start.

Notes

1. The delivery config must reference a service account in the top level field serviceAccount e.g. Example of this is available in .spinnaker.yml

name: test1
application: keeltest
serviceAccount: keeltest-service-account
artifacts: []
environments:[]
...

2. Create service account by following this page
3. If you'd like to use the kubernetes plugin for keel, example configuration is available here. It's commented out by default. Source is available here

Build binary and docker image

1. Ensure JDK 11 is installed or use a JDK 11 Docker image.
2. Clone keel repo: git clone [email protected]:spinnaker/keel.git
3. cd to root of the repo then build: ./gradlew keel-web:installDist
4. Build docker image: docker build -f Dockerfile.ubuntu -t <TAG> .