OpsMx Enterprise for Spinnaker is an installation bundle that includes the open source Spinnaker and OpsMx extensions on top of it.

For more information, visit https://www.opsmx.com

Install OpsMx Enterprise for Spinnaker

$ helm repo add opsmx https://helmcharts.opsmx.com/
$ helm install <release-name> opsmx/oes --set imageCredentials.username=<dockerID> --set imageCredentials.password=<dockerPassword>

• Kubernetes cluster 1.15 or later with at least 6 cores and 20 GB memory
• Helm 3 is setup on the client system

  $ helm version

  If helm is not setup, follow https://helm.sh/docs/intro/install/ to install helm.

• Add opsmx helm repo to your local machine

  $ helm repo add opsmx https://helmcharts.opsmx.com/

  Note: If opsmx helm repo is already added, do a repo update before installing the chart

  $ helm repo update

• Quay container registry credentials is setup as a secret in Kubernetes. Before you install OES, please send an email to [email protected] requesting access to the OES images with your Quay ID. You can proceed with installation once your Quay ID has been granted access.

  To be able to fetch OES container images, do anything of the below actions

  1. username and password shall be set in values.yaml or
  2. use --set imageCredentials.username= --set imageCredentials.password= while running helm install or
  3. Create an imagePullSecret with your quay credentials and specify the secret name using --set imagePullSecret=

• Your Kubernetes cluster shall support persistent volumes

• It is assumed that an nginx ingress controller is installed on the cluster, by default ingress resources are created for oes-ui, oes-gate, spin-deck and spin-gate services. Customize the hosts for OES using the options in the values.yaml under oesUI, oesGate, spinDeck, spinGate. If any other ingress controller is installed, set createIngress flag to false and configure your ingress.

• To enable mutual TLS for Spinnaker Services and SSL features provided by Spinnaker Life Cycle Management (LCM), it is required to install nginx ingress from kubernetes community and cert-manager before installing OES. Please refer the table below for options to be enabled for LCM Instructions to install nginx ingress https://kubernetes.github.io/ingress-nginx/deploy/

  Instructions to install cert-manager https://cert-manager.io/docs/installation/kubernetes/

• Helm v3 expects the namespace to be present before helm install command is run. If it does not exists,

  $ kubectl create namespace mynamespace

• To install the chart with the release name my-release:

  Helm v3.x

  $ helm install my-release opsmx/oes [--namespace mynamespace]

The command deploys OES on the Kubernetes cluster in the default configuration. The configuration section lists the parameters that can be configured during installation.

Tip: List all releases using helm list

To uninstall/delete the my-release deployment:

Helm v3.x

$ helm uninstall my-release [--namespace mynamespace]

The command removes all the Kubernetes components associated with the chart and deletes the release.

The following table lists the configurable parameters of the OES chart and their default values.

Tip: Refer to values.yaml for detailed comments

Tip: Refer to Spinnaker helm chart & EFK helm chart for their configuration details.

Specify each parameter using the --set key=value[,key=value] argument to helm install. For example,

$ helm install my-release opsmx/oes --set installSpinnaker=false --set installRedis=true --set imageCredentials.username=username \
--set imageCredentials.password=password [--namespace mynamespace]

Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. For example, OES values.yaml can be first downloaded using below command and then customized.

wget https://raw.githubusercontent.com/opsmx/enterprise-spinnaker/master/charts/oes/values.yaml

Helm v3.x

$ helm install my-release opsmx/oes -f values.yaml

Once the service is up and running, find the service ip address

kubectl get svc spin-deck-np [--namespace mynamespace]

Example output would be:

  NAME           TYPE           CLUSTER-IP     EXTERNAL-IP   PORT(S)          AGE
  spin-deck-np   LoadBalancer   10.0.139.222   40.78.4.201   9000:31030/TCP   8m9s

Using the EXTERNAL-IP address, go to http://EXTERNAL-IP:9000/

Once the service is up and running, find the service ip address

kubectl get svc oes-ui [--namespace mynamespace]

Example output would be:

NAME        TYPE              CLUSTER-IP      EXTERNAL-IP     PORT(S)         AGE
oes-ui      LoadBalancer      10.0.33.110     52.149.54.222   80:30860/TCP    20m

Using the EXTERNAL-IP address, go to http://EXTERNAL-IP:80/

You can login with dummysuer/dummypwd

Spinnaker consists of multiple microservices and you need to connect to each microservice to see what is going on. We have enabled elasticsearch, fluentbit and kibana to provide a centralized logging solution for Spinnaker. To enable it, you need to install with the flag

    --set enableCentralLogging=true

Note, that out-of-the-box configuration of the service requires addition 2G of memory and 1 core. To get the hostname for Kibana, run

    kubectl get svc [--namespace mynamespace]

and find the service with Kibana in the name. Example output would be:

  NAME               TYPE           CLUSTER-IP   EXTERNAL-IP     PORT(S)      AGE
  somename-kibana    LoadBalancer   10.0.4.246   34.66.226.138   5601:32097   9m43s

Using the EXTERNAL-IP address, go to http://EXTERNAL-IP:5601

In Kibana, go to Discover -> Open -> Spinnaker Logs to see logs from Spinnaker pods.