Instructions for migrating deployments from helm/stable to charts.anchore.io
This chart deploys the Anchore Engine docker container image analysis system. Anchore Engine requires a PostgreSQL database (>=9.6) which may be handled by the chart or supplied externally, and executes in a service based architecture utilizing the following Anchore Engine services: External API, SimpleQueue, Catalog, Policy Engine, and Analyzer.
This chart can also be used to install the following Anchore Enterprise services: GUI, RBAC, Reporting, Notifications & On-premises Feeds. Enterprise services require a valid Anchore Enterprise License as well as credentials with access to the private DockerHub repository hosting the images. These are not enabled by default.
Each of these services can be scaled and configured independently.
See Anchore Engine for more project details.
The chart is split into global and service specific configurations for the OSS Anchore Engine, as well as global and services specific configurations for the Enterprise components.
- The
anchoreGlobal
section is for configuration values required by all Anchore Engine components. - The
anchoreEnterpriseGlobal
section is for configuration values required by all Anchore Engine Enterprise components. - Service specific configuration values allow customization for each individual service.
For a description of each component, view the official documentation at: Anchore Enterprise Service Overview
helm repo add anchore https://charts.anchore.io
helm install my-release anchore/anchore-engine
Anchore Engine will take approximately 3 minutes to bootstrap. After the initial bootstrap period, Anchore Engine will begin a vulnerability feed sync. During this time, image analysis will show zero vulnerabilities until the sync is completed. This sync can take multiple hours depending on which feeds are enabled. The following anchore-cli command is available to poll the system and report back when the engine is bootstrapped and the vulnerability feeds are all synced up. anchore-cli system wait
The recommended way to install the Anchore Engine Helm Chart is with a customized values file and a custom release name. It is highly recommended to set non-default passwords when deploying, all passwords are set to defaults specified in the chart. It is also recommended to utilize an external database, rather then using the included postgresql chart.
Create a new file named anchore_values.yaml
and add all desired custom values (examples below); then run the following command:
helm repo add anchore https://charts.anchore.io
helm install <release_name> -f anchore_values.yaml anchore/anchore-engine
Note: Installs with chart managed PostgreSQL database. This is not a guaranteed production ready config.
## anchore_values.yaml
postgresql:
postgresPassword: <PASSWORD>
persistence:
size: 50Gi
anchoreGlobal:
defaultAdminPassword: <PASSWORD>
defaultAdminEmail: <EMAIL>
The following features are available to Anchore Enterprise customers. Please contact the Anchore team for more information about getting a license for the enterprise features. Anchore Enterprise Demo
* Role based access control
* LDAP integration
* Graphical user interface
* Customizable UI dashboards
* On-premises feeds service
* Proprietary vulnerability data feed (vulnDB, MSRC)
* Anchore reporting API
* Notifications - Slack, GitHub, Jira, etc
* Microsoft image vulnerability scanning
* Kubernetes runtime image inventory/scanning
Enterprise services require an Anchore Enterprise license, as well as credentials with permission to the private docker repositories that contain the enterprise images.
To use this Helm chart with the enterprise services enabled, perform these steps.
-
Create a kubernetes secret containing your license file.
kubectl create secret generic anchore-enterprise-license --from-file=license.yaml=<PATH/TO/LICENSE.YAML>
-
Create a kubernetes secret containing DockerHub credentials with access to the private anchore enterprise repositories.
kubectl create secret docker-registry anchore-enterprise-pullcreds --docker-server=docker.io --docker-username=<DOCKERHUB_USER> --docker-password=<DOCKERHUB_PASSWORD> --docker-email=<EMAIL_ADDRESS>
-
(demo) Install the Helm chart using default values
helm repo add anchore https://charts.anchore.io helm install <release_name> --set anchoreEnterpriseGlobal.enabled=true anchore/anchore-engine
-
(production) Install the Helm chart using a custom anchore_values.yaml file - see examples below
helm repo add anchore https://charts.anchore.io helm install <release_name> -f anchore_values.yaml anchore/anchore-engine
Note: Installs with chart managed PostgreSQL & Redis databases. This is not a guaranteed production ready config.
## anchore_values.yaml
postgresql:
postgresPassword: <PASSWORD>
persistence:
size: 50Gi
anchoreGlobal:
defaultAdminPassword: <PASSWORD>
defaultAdminEmail: <EMAIL>
enableMetrics: True
anchoreEnterpriseGlobal:
enabled: True
anchore-feeds-db:
postgresPassword: <PASSWORD>
persistence:
size: 20Gi
anchore-ui-redis:
password: <PASSWORD>
As of chart version 1.3.1 deployments to OpenShift are fully supported. Due to permission constraints when utilizing OpenShift, the official RHEL postgresql image must be utilized, which requires custom environment variables to be configured for compatibility with this chart.
Note: Installs with chart managed PostgreSQL database. This is not a guaranteed production ready config.
## anchore_values.yaml
postgresql:
image: registry.access.redhat.com/rhscl/postgresql-96-rhel7
imageTag: latest
extraEnv:
- name: POSTGRESQL_USER
value: anchoreengine
- name: POSTGRESQL_PASSWORD
value: anchore-postgres,123
- name: POSTGRESQL_DATABASE
value: anchore
- name: PGUSER
value: postgres
- name: LD_LIBRARY_PATH
value: /opt/rh/rh-postgresql96/root/usr/lib64
- name: PATH
value: /opt/rh/rh-postgresql96/root/usr/bin:/opt/app-root/src/bin:/opt/app-root/bin:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin
postgresPassword: <PASSWORD>
persistence:
size: 50Gi
anchoreGlobal:
defaultAdminPassword: <PASSWORD>
defaultAdminEmail: <EMAIL>
openShiftDeployment: True
To perform an Enterprise deployment on OpenShift use the following anchore_values.yaml configuration
Note: Installs with chart managed PostgreSQL database. This is not a guaranteed production ready config.
## anchore_values.yaml
postgresql:
image: registry.access.redhat.com/rhscl/postgresql-96-rhel7
imageTag: latest
extraEnv:
- name: POSTGRESQL_USER
value: anchoreengine
- name: POSTGRESQL_PASSWORD
value: anchore-postgres,123
- name: POSTGRESQL_DATABASE
value: anchore
- name: PGUSER
value: postgres
- name: LD_LIBRARY_PATH
value: /opt/rh/rh-postgresql96/root/usr/lib64
- name: PATH
value: /opt/rh/rh-postgresql96/root/usr/bin:/opt/app-root/src/bin:/opt/app-root/bin:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin
postgresPassword: <PASSWORD>
persistence:
size: 20Gi
anchoreGlobal:
defaultAdminPassword: <PASSWORD>
defaultAdminEmail: <EMAIL>
enableMetrics: True
openShiftDeployment: True
anchoreEnterpriseGlobal:
enabled: True
anchore-feeds-db:
image: registry.access.redhat.com/rhscl/postgresql-96-rhel7
imageTag: latest
extraEnv:
- name: POSTGRESQL_USER
value: anchoreengine
- name: POSTGRESQL_PASSWORD
value: anchore-postgres,123
- name: POSTGRESQL_DATABASE
value: anchore
- name: PGUSER
value: postgres
- name: LD_LIBRARY_PATH
value: /opt/rh/rh-postgresql96/root/usr/lib64
- name: PATH
value: /opt/rh/rh-postgresql96/root/usr/bin:/opt/app-root/src/bin:/opt/app-root/bin:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin
postgresPassword: <PASSWORD>
persistence:
size: 50Gi
anchore-ui-redis:
password: <PASSWORD>
See the anchore-engine CHANGELOG for updates to anchore engine.
A Helm post-upgrade hook job will shut down all previously running Anchore services and perform the Anchore DB upgrade process using a kubernetes job. The upgrade will only be considered successful when this job completes successfully. Performing an upgrade will cause the Helm client to block until the upgrade job completes and the new Anchore service pods are started. To view progress of the upgrade process, tail the logs of the upgrade jobs anchore-engine-upgrade
and anchore-enterprise-upgrade
. These job resources will be removed upon a successful helm upgrade.
- Anchore Engine image updated to v0.10.1 - Release Notes
- Anchore Enterprise image updated to v3.1.1 - Release Notes
- Enterprise Feeds - MSRC feeds no longer require an access token. No changes are needed, however MSRC access tokens can now be removed from values and/or existing secrets.
- Anchore Engine image updated to v0.10.0 - Release Notes
- Anchore Enterprise image updated to v3.1.0 - Release Notes
- If utilizing the Enterprise Runtime Inventory feature, the catalog service can now be configured to automatically setup RBAC for image discovery within the cluster. This is configured under
.Values.anchoreCatalog.runtimeInventory
- Anchore Engine image updated to v0.9.1
- Anchore Enterprise images updated to v3.0.0
- Existing secrets now work for Enterprise Feeds and Enterprise UI - see existing secrets configuration
- Anchore admin default password no longer defaults to
foobar
, if no password is specified a random string will be generated.
Chart dependency declarations have been updated to be compatible with Helm v3.4.0
The following Anchore-Engine features were added with this version:
- Malware scanning - see .Values.anchoreAnalyzer.configFile.malware
- Binary content scanning
- Content hints file analysis - see .Values.anchoreAnalyzer.enableHints
- Updated image deletion behavior
For more details see - https://docs.anchore.com/current/docs/engine/releasenotes/080
Starting with version 1.7.0 the anchore-engine chart will be hosted on charts.anchore.io - if you're upgrading from a previous version of the chart, you will need to delete your previous deployment and redeploy Anchore Engine using the chart from the Anchore Charts repository.
This version of the chart includes the dependent Postgresql chart in the charts/ directory rather then pulling it from upstream. All apiVersions were updated for compatibility with kubernetes v1.16+ and the postgresql image has been updated to version 9.6.18. The chart version also updates to the latest version of the Redis chart from Bitnami. These dependency updates require deleting and re-installing your chart. If the following process is performed, no data should be lost.
For these examples, we assume that your namespace is called my-namespace
and your Anchore installation is called my-anchore
.
These examples use Helm version 3 and kubectl client version 1.18, server version 1.18.
All helm installation steps will include a flag to override the Anchore Engine/Enterprise images with your current running version. Upgrading your version of Anchore can be performed after moving to the new chart from charts.anchore.io. Record the version of your Anchore deployment and use it anytime the instructions refer to the Engine Code Version.
Connect to the anchore-api pod, issue the following command and record the Engine Code Version:
[anchore@anchore-api anchore-engine]$ anchore-cli system status
Service analyzer (anchore-anchore-engine-analyzer-7cd9c5cb78-j8n8p, http://anchore-anchore-engine-analyzer:8084): up
Service apiext (anchore-anchore-engine-api-54cff87fcd-s4htm, http://anchore-anchore-engine-api:8228): up
Service catalog (anchore-anchore-engine-catalog-5898dc67d6-64b8n, http://anchore-anchore-engine-catalog:8082): up
Service simplequeue (anchore-anchore-engine-simplequeue-5cc449cc5c-djkf7, http://anchore-anchore-engine-simplequeue:8083): up
Service policy_engine (anchore-anchore-engine-policy-68b99ddf96-d4gbl, http://anchore-anchore-engine-policy:8087): up
Engine DB Version: 0.0.13
Engine Code Version: 0.7.2
helm uninstall --namespace=my-namespace my-anchore
helm repo add anchore https://charts.anchore.io
helm repo update
export ANCHORE_VERSION=0.7.2 # USE YOUR ENGINE CODE VERSION HERE
helm install --namespace=my-namespace --set anchoreGlobal.image=docker.io/anchore/anchore-engine:v${ANCHORE_VERSION} --set anchoreEnterpriseGlobal.image=docker.io/anchore/enterprise:v${ANCHORE_VERSION} -f anchore_values.yaml my-anchore anchore/anchore-engine
When utilizing the included Postgresql chart you will need to reuse the persistent volume claims that are attached to your current deployment. These existing claims will be utilized when re-installing anchore-engine using the new chart from charts.anchore.io.
Find the name of the database PersistentVolumeClaim using kubectl
:
$ kubectl get persistentvolumeclaim --namespace my-namespace
NAME STATUS VOLUME CAPACITY ACCESS MODES STORAGECLASS AGE
my-anchore-postgresql Bound pvc-739f6f21-b73b-11ea-a2b9-42010a800176 20Gi RWO standard 2d
The name of your PersistentVolumeClaim in the example shown is my-anchore-postgresql
. Note that, as you will need it later.
Anchore Enterprise users with a standalone Feeds Service will see a different set of PersistentVolumeClaims:
$ kubectl get persistentvolumeclaim --namespace my-namespace
NAME STATUS VOLUME CAPACITY ACCESS MODES STORAGECLASS AGE
my-anchore-anchore-feeds-db Bound pvc-cd7ebb6f-bbe0-11ea-b9bf-42010a800020 20Gi RWO standard 3d
my-anchore-postgresql Bound pvc-cd7dc7d2-bbe0-11ea-b9bf-42010a800020 20Gi RWO standard 3d
The names of the PersistentVolumeClaims in the example shown are my-anchore-anchore-feeds-db
and my-anchore-postgresql
. You may see other persistent volume claims, but only my-anchore-anchore-feeds-db
and my-anchore-postgresql
are relevant for this migration; note the names, as you will need them later.
$ helm uninstall --namespace=my-namespace my-anchore
release "my-anchore" uninstalled
Anchore Enterprise users will want to remove the Redis DB PersistentVolumeClaim; this will delete all current session data but will not affect stability of the deployment:
kubectl delete pvc redis-data-my-anchore-anchore-ui-redis-master-0
Your other PersistentVolumeClaims will still be resident in your cluster (we're showing results from an Anchore Enterprise installation that has a standalone Feeds Service below; Anchore Enterprise users without a standalone Feeds Service and Anchore Engine users will not see my-anchore-anchore-feeds-db
):
$ kubectl get persistentvolumeclaim --namespace my-namespace
NAME STATUS VOLUME CAPACITY ACCESS MODES STORAGECLASS AGE
my-anchore-anchore-feeds-db Bound pvc-a22abf70-bbb9-11ea-840b-42010a8001d8 20Gi RWO standard 3d
my-anchore-postgresql Bound pvc-e6daf90a-bbb8-11ea-840b-42010a8001d8 20Gi RWO standard 3d
$ helm repo add anchore https://charts.anchore.io
"anchore" has been added to your repositories
$ helm repo update
Hang tight while we grab the latest from your chart repositories...
...Successfully got an update from the "anchore" chart repository
Update your anchore_values.yaml file as shown, using the PersistentVolumeClaim values from above:
Engine only deployment values file example:
# anchore_values.yaml
postgresql:
persistence:
existingclaim: my-anchore-postgresql
Enterprise deployment values file example:
# anchore_values.yaml
postgresql:
persistence:
existingclaim: my-anchore-postgresql
anchore-feeds-db:
persistence:
existingclaim: my-anchore-anchore-feeds-db
Install a new Anchore Engine deployment using the chart from charts.anchore.io
$ export ANCHORE_VERSION=0.7.2 # USE YOUR ENGINE CODE VERSION HERE
$ helm install --namespace=my-namespace --set anchoreGlobal.image=docker.io/anchore/anchore-engine:v${ANCHORE_VERSION} --set anchoreEnterpriseGlobal.image=docker.io/anchore/enterprise:v${ANCHORE_VERSION} -f anchore_values.yaml my-anchore anchore/anchore-engine
NAME: my-anchore
LAST DEPLOYED: Thu Jun 25 12:25:33 2020
NAMESPACE: my-namespace
STATUS: deployed
REVISION: 1
TEST SUITE: None
NOTES:
To use Anchore Engine you need the URL, username, and password to access the API.
...more instructions...
Verify that your PersistentVolumeClaims are bound (output may vary):
$ kubectl get persistentvolumeclaim --namespace my-namespace
NAME STATUS VOLUME CAPACITY ACCESS MODES STORAGECLASS AGE
my-anchore-anchore-feeds-db Bound pvc-a22abf70-bbb9-11ea-840b-42010a8001d8 20Gi RWO standard 3d
my-anchore-postgresql Bound pvc-e6daf90a-bbb8-11ea-840b-42010a8001d8 20Gi RWO standard 3d
Connect to the anchore-api pod and validate that your installation still contains all of your previously scanned images.
[anchore@anchore-api anchore-engine]$ anchore-cli image list
Full Tag Image Digest Analysis Status
docker.io/alpine:latest sha256:a15790640a6690aa1730c38cf0a440e2aa44aaca9b0e8931a9f2b0d7cc90fd65 analyzed
docker.io/anchore/anchore-engine:latest sha256:624c9f662233838d1046809135a70ab88d79bd0f2e53dd74bb3d67d10d997bd1 analyzed
docker.io/ubuntu:latest sha256:60f560e52264ed1cb7829a0d59b1ee7740d7580e0eb293aca2d722136edb1e24 analyzed
You are now running Anchore from the new chart repository, with your data in place.
Now that you're migrated to charts.anchore.io you can upgrade Anchore Engine to the latest version if desired.
helm upgrade --namespace my-namespace -f anchore_values.yaml my-anchore anchore/anchore-engine
All configurations should be appended to your custom anchore_values.yaml
file and utilized when installing the chart. While the configuration options of Anchore Engine are extensive, the options provided by the chart are:
This configuration allows SSL termination using your chosen ingress controller.
ingress:
enabled: true
ingress:
enabled: true
annotations:
kubernetes.io/ingress.class: alb
alb.ingress.kubernetes.io/scheme: internet-facing
apiPath: /v1/*
uiPath: /*
apiHosts:
- anchore-api.example.com
uiHosts:
- anchore-ui.example.com
anchoreApi:
service:
type: NodePort
anchoreEnterpriseUi:
service
type: NodePort
ingress:
enabled: true
annotations:
kubernetes.io/ingress.class: gce
apiPath: /v1/*
uiPath: /*
apiHosts:
- anchore-api.example.com
uiHosts:
- anchore-ui.example.com
anchoreApi:
service:
type: NodePort
anchoreEnterpriseUi:
service
type: NodePort
anchoreApi:
service:
type: LoadBalancer
Secrets should be created prior to running helm install
. These can be used to override the secret provisioned by the helm chart, preventing plaintext passwords in your values.yaml file.
anchoreGlobal:
# The secret should define the following environment vars:
# ANCHORE_ADMIN_PASSWORD
# ANCHORE_DB_PASSWORD
# ANCHORE_SAML_SECRET (if applicable)
existingSecret: "anchore-engine-secrets"
anchoreEnterpriseFeeds:
# The secret should define the following environment vars:
# ANCHORE_ADMIN_PASSWORD
# ANCHORE_FEEDS_DB_PASSWORD
# ANCHORE_SAML_SECRET (if applicable)
existingSecret: "anchore-feeds-secrets"
anchoreEnterpriseUI:
# This secret should define the following ENV vars
# ANCHORE_APPDB_URI
# ANCHORE_REDIS_URI
existingSeccret: "anchore-ui-secrets"
Note: it is recommended to use an external Postgresql instance for production installs.
See comments in the values.yaml file for details on using SSL for external database connections.
postgresql:
postgresPassword: <PASSWORD>
postgresUser: <USER>
postgresDatabase: <DATABASE>
enabled: false
externalEndpoint: <HOSTNAME:5432>
anchoreGlobal:
dbConfig:
ssl: true
sslMode: require
## anchore_values.yaml
postgresql:
enabled: false
postgresPassword: <CLOUDSQL-PASSWORD>
postgresUser: <CLOUDSQL-USER>
postgresDatabase: <CLOUDSQL-DATABASE>
cloudsql:
enabled: true
instance: "project:zone:cloudsqlinstancename"
# Optional existing service account secret to use.
useExistingServiceAcc: true
serviceAccSecretName: my_service_acc
serviceAccJsonName: for_cloudsql.json
image:
repository: gcr.io/cloudsql-docker/gce-proxy
tag: 1.12
pullPolicy: IfNotPresent
Note: it is recommended to use an external archive driver for production installs.
The archive subsystem of Anchore Engine is what stores large json documents and can consume quite a lot of storage if you analyze a lot of images. A general rule for storage provisioning is 10MB per image analyzed, so with thousands of analyzed images, you may need many gigabytes of storage. The Archive drivers now support other backends than just postgresql, so you can leverage external and scalable storage systems and keep the postgresql storage usage to a much lower level.
The archive system has compression available to help reduce size of objects and storage consumed in exchange for slightly slower performance and more cpu usage. There are two config values:
To toggle on/off (default is True), and set a minimum size for compression to be used (to avoid compressing things too small to be of much benefit, the default is 100):
anchoreCatalog:
archive:
compression:
enabled=True
min_size_kbytes=100
- S3 - Any AWS s3-api compatible system (e.g. minio, scality, etc)
- OpenStack Swift
- Local FS - A local filesystem on the core pod. Does not handle sharding or replication, so generally only for testing.
- DB - the default postgresql backend
anchoreCatalog:
archive:
storage_driver:
name: 's3'
config:
access_key: 'MY_ACCESS_KEY'
secret_key: 'MY_SECRET_KEY'
#iamauto: True
url: 'https://S3-end-point.example.com'
region: null
bucket: 'anchorearchive'
create_bucket: True
compression:
... # Compression config here
The swift configuration is basically a pass-thru to the underlying pythonswiftclient so it can take quite a few different options depending on your swift deployment and config. The best way to configure the swift driver is by using a custom values.yaml
The Swift driver supports three authentication methods:
- Keystone V3
- Keystone V2
- Legacy (username / password)
anchoreCatalog:
archive:
storage_driver:
name: swift
config:
auth_version: '3'
os_username: 'myusername'
os_password: 'mypassword'
os_project_name: myproject
os_project_domain_name: example.com
os_auth_url: 'foo.example.com:8000/auth/etc'
container: 'anchorearchive'
# Optionally
create_container: True
compression:
... # Compression config here
anchoreCatalog:
archive:
storage_driver:
name: swift
config:
auth_version: '2'
os_username: 'myusername'
os_password: 'mypassword'
os_tenant_name: 'mytenant'
os_auth_url: 'foo.example.com:8000/auth/etc'
container: 'anchorearchive'
# Optionally
create_container: True
compression:
... # Compression config here
anchoreCatalog:
archive:
storage_driver:
name: swift
config:
user: 'user:password'
auth: 'http://swift.example.com:8080/auth/v1.0'
key: 'anchore'
container: 'anchorearchive'
# Optionally
create_container: True
compression:
... # Compression config here
This is the default archive driver and requires no additional configuration.
Anchore Engine supports exporting prometheus metrics form each container. To enable metrics:
anchoreGlobal:
enableMetrics: True
When enabled, each service provides the metrics over the existing service port so your prometheus deployment will need to know about each pod and the ports it provides to scrape the metrics.
A secret needs to be created in the same namespace as the anchore-engine chart installation. This secret should contain all custom certs, including CA certs & any certs used for internal TLS communication. This secret will be mounted to all anchore-engine pods at /home/anchore/certs to be utilized by the system.
Anchore Engine in v0.2.3 introduces a new events subsystem that exposes system-wide events via both a REST api as well as via webhooks. The webhooks support filtering to ensure only certain event classes result in webhook calls to help limit the volume of calls if you desire. Events, and all webhooks, are emitted from the core components, so configuration is done in the coreConfig.
To configure the events:
anchoreCatalog:
events:
notification:
enabled:true
level=error
As of Chart version 0.9.0, all services can now be scaled-out by increasing the replica counts. The chart now supports this configuration.
To set a specific number of service containers:
anchoreAnalyzer:
replicaCount: 5
anchorePolicyEngine:
replicaCount: 3
To update the number in a running configuration:
helm upgrade --set anchoreAnalyzer.replicaCount=2 <releasename> anchore/anchore-engine -f anchore_values.yaml