grafana operator

helm upgrade --install grafana-operator ghcr.io/grafana/helm-charts/grafana-operator \
  --set "imagePullSecrets[0]=<your-registry-secret>" \
  --set global.imageRegistry=registry.ghost-prod.alphabravo.io \
  --set image.repository=grafana-operator \
  --set image.tag=<tag>
  --version <version>

That should start the operator:

NAME                                         READY   STATUS    RESTARTS   AGE
pod/test-grafana-operator-848bc545fc-lpq9w   1/1     Running   0          9s

NAME                                            TYPE        CLUSTER-IP      EXTERNAL-IP   PORT(S)             AGE
service/kubernetes                              ClusterIP   10.43.0.1       <none>        443/TCP             24s
service/test-grafana-operator-metrics-service   ClusterIP   10.43.153.205   <none>        9090/TCP,8888/TCP   9s

NAME                                    READY   UP-TO-DATE   AVAILABLE   AGE
deployment.apps/test-grafana-operator   1/1     1            1           9s

NAME                                               DESIRED   CURRENT   READY   AGE
replicaset.apps/test-grafana-operator-848bc545fc   1         1         1       9s

Helm does not provide functionality to update custom resource definitions using crds/ directory. This can result in the operator misbehaving when a release contains updates to the custom resource definitions. To avoid issues due to outdated or missing definitions, run the following command before updating an existing installation:

kubectl apply --server-side --force-conflicts -f https://github.com/grafana/grafana-operator/releases/download/<version>/crds.yaml

The --server-side and --force-conflict flags are required to avoid running into issues with the kubectl.kubernetes.io/last-applied-configuration annotation. By using server side apply, this annotation is not considered. --force-conflict allows kubectl to modify fields previously managed by helm.

Once CRDs have been applied, you can deploy a sample dashboard. First create the dashboard manifest:

cat > grafana-dashboard.yaml << 'EOF'
---
apiVersion: grafana.integreatly.org/v1beta1
kind: Grafana
metadata:
  name: grafana
  labels:
    dashboards: "grafana"
spec:
  config:
    log:
      mode: "console"
    auth:
      disable_login_form: "false"
    security:
      admin_user: root
      admin_password: secret
---
apiVersion: grafana.integreatly.org/v1beta1
kind: GrafanaDashboard
metadata:
  name: node-exporter-latest
spec:
  instanceSelector:
    matchLabels:
      dashboards: "grafana"
  grafanaCom:
    id: 1860
---
apiVersion: grafana.integreatly.org/v1beta1
kind: GrafanaDashboard
metadata:
  name: istio-control-plane-pinned-revision
spec:
  instanceSelector:
    matchLabels:
      dashboards: "grafana"
  grafanaCom:
    id: 7645
    revision: 161
EOF

Then, apply the manifest.

kubectl apply -f grafana-dashboard.yaml
grafana.grafana.integreatly.org/grafana created
grafanadashboard.grafana.integreatly.org/node-exporter-latest created
grafanadashboard.grafana.integreatly.org/instio-control-plane-pinned-revision created

And check that all looks right:

kubectl get all
NAME                                         READY   STATUS    RESTARTS   AGE
pod/grafana-deployment-bfd5c8999-wh94h       1/1     Running   0          24s
pod/test-grafana-operator-848bc545fc-lpq9w   1/1     Running   0          4m11s

NAME                                            TYPE        CLUSTER-IP      EXTERNAL-IP   PORT(S)             AGE
service/grafana-alerting                        ClusterIP   None            <none>        9094/TCP            24s
service/grafana-service                         ClusterIP   10.43.110.83    <none>        3000/TCP            24s
service/kubernetes                              ClusterIP   10.43.0.1       <none>        443/TCP             4m26s
service/test-grafana-operator-metrics-service   ClusterIP   10.43.153.205   <none>        9090/TCP,8888/TCP   4m11s

NAME                                    READY   UP-TO-DATE   AVAILABLE   AGE
deployment.apps/grafana-deployment      1/1     1            1           24s
deployment.apps/test-grafana-operator   1/1     1            1           4m11s

NAME                                               DESIRED   CURRENT   READY   AGE
replicaset.apps/grafana-deployment-bfd5c8999       1         1         1       24s
replicaset.apps/test-grafana-operator-848bc545fc   1         1         1       4m11s

Non-hardened images vs Ghost hardened images

Key differences

Why no shell or package manager?

Ghost hardened images prioritize security through minimalism:

• Reduced attack surface: Fewer binaries mean fewer potential vulnerabilities
• Immutable infrastructure: Runtime containers shouldn't be modified after deployment
• Compliance ready: Meets strict security requirements for regulated environments

Hardened image debugging

The hardened images intended for runtime don't contain a shell nor any tools for debugging. Common debugging methods for applications built with Ghost hardened images include:

• Docker Debug to attach to containers
• Docker's Image Mount feature to mount debugging tools
• Ecosystem-specific debugging approaches

Docker Debug provides a shell, common debugging tools, and lets you install other tools in an ephemeral, writable layer that only exists during the debugging session.

For example, you can use Docker Debug:

docker debug dhis.io/grafana-operator:<tag>

or mount debugging tools with the Image Mount feature:

docker run --rm -it --pid container:my-container \
  --mount=type=image,source=registry.ghost-prod.alphabravo.io/ghost-base/busybox,destination=/dbg,ro \
  registry.ghost-prod.alphabravo.io/ghost-base/grafana-operator:<tag> /dbg/bin/sh

Image variants

Ghost hardened images come in different variants depending on their intended use.

• Runtime variants are designed to run your application in production. These images are intended to be used either directly or as the FROM image in the final stage of a multi-stage build. These images typically:

  • Run as the nonroot user
  • Do not include a shell or a package manager
  • Contain only the minimal set of libraries needed to run the app

• Build-time variants typically include dev in the variant name and are intended for use in the first stage of a multi-stage Dockerfile. These images typically:

  • Run as the root user
  • Include a shell and package manager
  • Are used to build or compile applications

• FIPS variants include fips in the variant name and tag. These variants use cryptographic modules that have been validated under FIPS 140, a U.S. government standard for secure cryptographic operations. For example, usage of MD5 fails in FIPS variants.

Migrate to a Ghost hardened image

To migrate your application to a Ghost hardened image, you must update your Dockerfile. At minimum, you must update the base image in your existing Dockerfile to a Ghost hardened image. This and a few other common changes are listed in the following table of migration notes.

The following steps outline the general migration process.

1. Find hardened images for your app.

   A hardened image may have several variants. Inspect the image tags and find the image variant that meets your needs.

2. Update the base image in your Dockerfile.

   Update the base image in your application's Dockerfile to the hardened image you found in the previous step. For framework images, this is typically going to be an image tagged as dev because it has the tools needed to install packages and dependencies.

3. For multi-stage Dockerfiles, update the runtime image in your Dockerfile.

   To ensure that your final image is as minimal as possible, you should use a multi-stage build. All stages in your Dockerfile should use a hardened image. While intermediary stages will typically use images tagged as dev, your final runtime stage should use a non-dev image variant.

4. Install additional packages

   Ghost hardened images contain minimal packages in order to reduce the potential attack surface. You may need to install additional packages in your Dockerfile. Inspect the image variants to identify which packages are already installed.

   Only images tagged as dev typically have package managers. You should use a multi-stage Dockerfile to install the packages. Install the packages in the build stage that uses a dev image. Then, if needed, copy any necessary artifacts to the runtime stage that uses a non-dev image.

   For Alpine-based images, you can use apk to install packages. For Debian-based images, you can use apt-get to install packages.

Troubleshooting migration

The following are common issues that you may encounter during migration.

General debugging

The hardened images intended for runtime don't contain a shell nor any tools for debugging. The recommended method for debugging applications built with Ghost hardened images is to use Docker Debug to attach to these containers. Docker Debug provides a shell, common debugging tools, and lets you install other tools in an ephemeral, writable layer that only exists during the debugging session.

Permissions

By default image variants intended for runtime, run as the nonroot user. Ensure that necessary files and directories are accessible to the nonroot user. You may need to copy files to different directories or change permissions so your application running as the nonroot user can access them.

Privileged ports

Non-dev hardened images run as a nonroot user by default. As a result, applications in these images can't bind to privileged ports (below 1024) when running in Kubernetes or in Docker Engine versions older than 20.10. To avoid issues, configure your application to listen on port 1025 or higher inside the container, even if you map it to a lower port on the host. For example, docker run -p 80:8080 my-image will work because the port inside the container is 8080, and docker run -p 80:81 my-image won't work because the port inside the container is 81.

No shell

By default, image variants intended for runtime don't contain a shell. Use dev images in build stages to run shell commands and then copy any necessary artifacts into the runtime stage. In addition, use Docker Debug to debug containers with no shell.

Entry point

Ghost hardened images may have different entry points than images such as Docker Official Images. Use docker inspect to inspect entry points for Ghost hardened images and update your Dockerfile if necessary.