You are viewing version 2.26 of the documentation, which is no longer maintained. For up-to-date documentation, see the latest version.

Enable Policy Engine Plugin in Armory Enterprise

Enable the Policy Engine Plugin and connect it to your OPA server. When enabled, you can write policies that the Policy Engine enforces during save time, runtime validation, or when a user interacts with Armory Enterprise.

Proprietary

Before you start

Make sure the following requirements are met:

Setup

The Policy Engine Plugin can be enabled using one of the following methods:

  1. Docker image as an init container on each affected service

  2. Using a remote plugin repository

Docker image as init container

You can use the sample configuration to install the plugin, but keep the following in mind:

  • The patchesStrategicMerge section for each service is unique. Do not reuse the snippet from one service for the other services.

  • Make sure to replace <PLUGIN_VERSION> with the version of the plugin you want to use. For a list of versions, see Release notes.

  • This configuration must go into spinnakerservice.yml. It cannot be patched in through Kustomize.

Show the manifest
apiVersion: spinnaker.armory.io/v1alpha2
kind: SpinnakerService
metadata:
  name: spinnaker
spec:
  spinnakerConfig:
    profiles:
      # Configs in the spinnaker profile get applied to all services
      spinnaker:
        armory:
          policyEngine:
            opa:
              # Replace with the actual URL to your Open Policy Agent deployment
              baseUrl: https://opa.url:8181/v1/data
              # Optional. The number of seconds that the Policy Engine will wait for a response from the OPA server. Default is 10 seconds if omitted.
              # timeoutSeconds: <integer> 
        spinnaker:
          extensibility:
            repositories:
              policyEngine:
                enabled: true
                # The init container will install plugins.json to this path.
                url: file:///opt/spinnaker/lib/local-plugins/policy-engine/plugins.json
      gate:
        spinnaker:
          extensibility:
            plugins:
              Armory.PolicyEngine:
                enabled: true
            deck-proxy:
              enabled: true
              plugins:
                Armory.PolicyEngine:
                  enabled: true
                  version: <PLUGIN_VERSION>

      orca:
        spinnaker:
          extensibility:
            plugins:
              Armory.PolicyEngine:
                enabled: true

      front50:
        spinnaker:
          extensibility:
            plugins:
              Armory.PolicyEngine:
                enabled: true

      clouddriver:
        spinnaker:
          extensibility:
            plugins:
              Armory.PolicyEngine:
                enabled: true
  kustomize:
    front50:
      deployment:
        patchesStrategicMerge:
          - |
            spec:
              template:
                spec:
                  initContainers:
                    - name: policy-engine-install
                      image: armory/policy-engine-plugin:<PLUGIN_VERSION>
                      imagePullPolicy: Always
                      args:
                        - -install-path
                        - /opt/policy-engine-plugin/target
                      volumeMounts:
                        - mountPath: /opt/policy-engine-plugin/target
                          name: policy-engine-plugin-vol
                  containers:
                    - name: front50
                      volumeMounts:
                        - mountPath: /opt/spinnaker/lib/local-plugins
                          name: policy-engine-plugin-vol
                  volumes:
                    - name: policy-engine-plugin-vol
                      emptyDir: {}
    orca:
      deployment:
        patchesStrategicMerge:
          - |
            spec:
              template:
                spec:
                  initContainers:
                    - name: policy-engine-install
                      image: armory/policy-engine-plugin:<PLUGIN_VERSION>
                      imagePullPolicy: Always
                      args:
                        - -install-path
                        - /opt/policy-engine-plugin/target
                      volumeMounts:
                        - mountPath: /opt/policy-engine-plugin/target
                          name: policy-engine-plugin-vol
                  containers:
                    - name: orca
                      volumeMounts:
                        - mountPath: /opt/spinnaker/lib/local-plugins
                          name: policy-engine-plugin-vol
                  volumes:
                    - name: policy-engine-plugin-vol
                      emptyDir: {}
    gate:
      deployment:
        patchesStrategicMerge:
          - |
            spec:
              template:
                spec:
                  initContainers:
                    - name: policy-engine-install
                      image: armory/policy-engine-plugin:<PLUGIN_VERSION>
                      imagePullPolicy: Always
                      args:
                        - -install-path
                        - /opt/policy-engine-plugin/target
                      volumeMounts:
                        - mountPath: /opt/policy-engine-plugin/target
                          name: policy-engine-plugin-vol
                  containers:
                    - name: gate
                      volumeMounts:
                        - mountPath: /opt/spinnaker/lib/local-plugins
                          name: policy-engine-plugin-vol
                  volumes:
                    - name: policy-engine-plugin-vol
                      emptyDir: {}
    clouddriver:
      deployment:
        patchesStrategicMerge:
          - |
            spec:
              template:
                spec:
                  initContainers:
                    - name: policy-engine-install
                      image: armory/policy-engine-plugin:<PLUGIN_VERSION>
                      imagePullPolicy: Always
                      args:
                        - -install-path
                        - /opt/policy-engine-plugin/target
                      volumeMounts:
                        - mountPath: /opt/policy-engine-plugin/target
                          name: policy-engine-plugin-vol
                  containers:
                    - name: clouddriver
                      volumeMounts:
                        - mountPath: /opt/spinnaker/lib/local-plugins
                          name: policy-engine-plugin-vol
                  volumes:
                    - name: policy-engine-plugin-vol
                      emptyDir: {}

Optional settings

Timeout settings

You can configure the amount of time that the Policy Engine waits for a response from your OPA server. If you have network or latency issues, increasing the timeout can make Policy Engine more resilient. Use the following config to set the timeout in seconds: spec.spinnakerConfig.profiles.spinnaker.armory.policyEngine.opa.timeoutSeconds. The default timeout is 10 seconds if you omit the config.

  1. Add the following to profiles/spinnaker-local.yml:

    armory:
      policyEngine:
        opa:
          # Replace with the  URL to your OPA deployment   
          baseUrl: http://opa.server:8181/v1/data
    spinnaker:
      extensibility:
        repositories:
          policyEngine:
            enabled: true
            url: file:///opt/spinnaker/lib/local-plugins/policy-engine/plugins.json
    
  2. For each service you want to enable the plugin for, add the following snippet to its local profile. For example, add it to the file profiles/gate-local.yml for Gate.

    spinnaker:
      extensibility:
        plugins:
            Armory.PolicyEngine:
                enabled: true
    
  3. Add the following to service-settings/gate.yml, service-settings/orca.yml, service-settings/clouddriver.yml and service-settings/front50.yml:

    kubernetes:
      volumes:
      - id: policy-engine-install
        type: emptyDir
        mountPath: /opt/spinnaker/lib/local-plugins
    
  4. Configure Halyard by updating your .hal/config file. Use the following snippet and replace <PLUGIN VERSION> with the plugin version you want to use without the v prefix:

    deploymentConfigurations:
      - name: default
        deploymentEnvironment:
          initContainers:
            front50:
              - name: policy-engine-install
                image: docker.io/armory/policy-engine-plugin:<PLUGIN VERSION>
                args:
                  - -install-path
                  - /opt/policy-engine-plugin/target
                volumeMounts:
                  - mountPath: /opt/policy-engine-plugin/target
                    name: policy-engine-install
            clouddriver:
              - name: policy-engine-install
                image: docker.io/armory/policy-engine-plugin:<PLUGIN VERSION>
                args:
                  - -install-path
                  - /opt/policy-engine-plugin/target
                volumeMounts:
                  - mountPath: /opt/policy-engine-plugin/target
                    name: policy-engine-install
            gate:
              - name: policy-engine-install
                image: docker.io/armory/policy-engine-plugin:<PLUGIN VERSION>
                args:
                  - -install-path
                  - /opt/policy-engine-plugin/target
                volumeMounts:
                  - mountPath: /opt/policy-engine-plugin/target
                    name: policy-engine-install
            orca:
              - name: policy-engine-install
                image: docker.io/armory/policy-engine-plugin:<PLUGIN VERSION>
                args:
                  - -install-path
                  - /opt/policy-engine-plugin/target
                volumeMounts:
                  - mountPath: /opt/policy-engine-plugin/target
                    name: policy-engine-install
    

Remote plugin repository

The configuration is mostly identical to the Docker image method but omits all volumes and init container configurations. Additionally, replace all occurrences of the following:

url: file:///opt/spinnaker/lib/local-plugins/policy-engine/plugins.json

with:

url: https://raw.githubusercontent.com/armory-plugins/policy-engine-releases/master/repositories.json

If you do not omit the volume and initContainers configurations for the patchesStrategicMerge section, the pods for Armory may not start.

For information about loading a policy, see Using the Policy Engine.

Release notes

  • 0.1.6 - The Policy Engine Plugin is now generally available.
    • If you are new to using the Policy Engine, use the plugin instead of the extension project.
    • Entitlements using API Authorization no longer requires at least one policy. Previously, if you had no policies set, Policy Engine prevented any action from being taken. Now, Entitlements for Policy Engine allows any action to be taken if there are no policies set.
  • 0.1.4 - Adds the opa.timeoutSeconds property, which allows you to configure how long the Policy Engine waits for a response from the OPA server.
  • 0.1.3 - Fixes an issue introduced in v0.1.2 where the Project Configuration button’s name was changing when Policy Engine is enabled.
  • 0.1.2 - Adds support for writing policies against the package spinnaker.ui.entitlements.isFeatureEnabled to show/hide the following UI buttons:
    • Create Application
    • Application Config
    • Create Project
  • 0.0.25 - Fixes an unsatisfied dependency error in the API (Gate) when using SAML and x509 certificates. This fix requires Armory Enterprise 2.26.0 later.
  • 0.0.19 - Adds forced authentication feature and fixes NPE bug
  • 0.0.17 - Initial plugin release

Last modified July 28, 2021: (f3a804d)