### Install Datadog chart with app key and site (helm install)

Source: https://github.com/datadog/helm-charts/blob/main/charts/datadog/README.md

Installs the Datadog chart with a release name and sets the Datadog app key and site. The Datadog site can be configured via datadog.site.

```bash
helm install <RELEASE_NAME> \
    --set datadog.appKey=<DATADOG_APP_KEY> \
    --set datadog.site=<DATADOG_SITE> \
    datadog/datadog
```

--------------------------------

### Complete OpenShift configuration example

Source: https://github.com/datadog/helm-charts/blob/main/charts/private-action-runner/README.md

A comprehensive example of a values.yaml configuration for deploying the runner on OpenShift with SCC enabled.

```yaml
runner:
  config:
    urn: "YOUR_RUNNER_URN"
    privateKey: "YOUR_RUNNER_PRIVATE_KEY"

  # Enable SCC creation for OpenShift
  podSecurity:
    securityContextConstraints:
      create: true
    # Configure security settings as needed
    privileged: false
    # Adjust capabilities if required by your use case
    capabilities: []
    # Required dropped capabilities (can be customized)
    requiredDropCapabilities:
      - KILL
      - MKNOD
      - SETUID
      - SETGID
    # SELinux context configuration
    seLinuxContext:
      type: MustRunAs
    # Allowed volume types
    volumes:
      - configMap
      - csi
      - downwardAPI
      - emptyDir
      - ephemeral
      - persistentVolumeClaim
      - projected
      - secret
```

--------------------------------

### Install Datadog chart with API key (helm install)

Source: https://github.com/datadog/helm-charts/blob/main/charts/datadog/README.md

Installs the Datadog chart with the release name <RELEASE_NAME> and sets the Datadog API key. A Secret is created by default containing the API key.

```bash
helm install <RELEASE_NAME> \
    --set datadog.apiKey=<DATADOG_API_KEY> datadog/datadog
```

--------------------------------

### Install the Chart

Source: https://github.com/datadog/helm-charts/blob/main/charts/private-action-runner/README.md

Command to install the Datadog Private Action Runner chart using the specified values file.

```bash
helm install <RELEASE_NAME> datadog/private-action-runner -f values.yaml
```

--------------------------------

### Install Datadog Operator Chart

Source: https://github.com/datadog/helm-charts/blob/main/charts/datadog/templates/NOTES.txt

Command to install the datadog-operator chart to complete the migration.

```bash
helm install operator datadog/datadog-operator \
  --namespace {{ .Release.Namespace }} \
  --set datadogCRDs.crds.datadogAgents=true \
  --take-ownership
```

--------------------------------

### Install Datadog chart using existing secret (helm install)

Source: https://github.com/datadog/helm-charts/blob/main/charts/datadog/README.md

Installs the Datadog chart referencing a pre-created Kubernetes secret for the API key via `datadog.apiKeyExistingSecret`.

```bash
helm install <RELEASE_NAME> \
  --set datadog.apiKeyExistingSecret=$DATADOG_API_SECRET_NAME datadog/datadog
```

--------------------------------

### Verify Installation

Source: https://github.com/datadog/helm-charts/blob/main/charts/private-action-runner/README.md

Command to check the status of the runner pod using the release name label.

```bash
kubectl get pods -l app.kubernetes.io/instance=<RELEASE-NAME>
```

--------------------------------

### Install synthetics-private-location chart with config file

Source: https://github.com/datadog/helm-charts/blob/main/charts/synthetics-private-location/README.md

Installs the chart with a release name, using a local configuration file named config.json.

```bash
helm install <RELEASE_NAME> datadog/synthetics-private-location --set-file configFile=config.json
```

--------------------------------

### Install or upgrade the CloudPrem Helm chart

Source: https://github.com/datadog/helm-charts/blob/main/charts/cloudprem/README.md

Use this command to install or upgrade the CloudPrem release in a specific namespace using a custom values file.

```sh
helm upgrade --install <release name> datadog/cloudprem \
  -n <namespace name> \
  -f datadog-values.yaml
```

--------------------------------

### Configure values.yaml

Source: https://github.com/datadog/helm-charts/blob/main/charts/private-action-runner/README.md

Example configuration for the runner using the URN and private key obtained from the Datadog platform.

```yaml
runner:
  config:
    urn: "YOUR_RUNNER_URN"
    privateKey: "YOUR_RUNNER_PRIVATE_KEY"
```

--------------------------------

### Install or Upgrade Datadog Helm Chart

Source: https://github.com/datadog/helm-charts/blob/main/charts/datadog/README.md

Commands to install or upgrade the Datadog Helm chart using your custom values file.

```bash
helm install -f datadog-values.yaml <RELEASE_NAME> datadog/datadog
```

```bash
helm upgrade -f datadog-values.yaml <RELEASE_NAME> datadog/datadog
```

--------------------------------

### Values.yaml Migration Example

Source: https://github.com/datadog/helm-charts/blob/main/charts/private-action-runner/UPGRADING.md

A side-by-side comparison showing the transformation of a values.yaml file from version 0.x to 1.0.0.

```yaml
# Old structure (0.x)
runners:
  - name: "custom-runner"
    config:
      ddBaseURL: "https://app.datadoghq.com"
      urn: "my-urn"
      privateKey: "my-private-key"
    roleType: "Role"
    kubernetesActions:
      pods: ["get", "list"]

credentialFiles:
  - fileName: "creds.json"
    data: |
      { "credentials": [] }

# New structure (1.0.0)
runner:
  config:
    ddBaseURL: "https://app.datadoghq.com"
    urn: "my-urn"
    privateKey: "my-private-key"
  roleType: "Role"
  kubernetesActions:
    pods: ["get", "list"]
  credentialFiles:
    - fileName: "creds.json"
      data: |
        { "credentials": [] }
```

--------------------------------

### Install Observability Pipelines Worker chart with Datadog site

Source: https://github.com/datadog/helm-charts/blob/main/charts/observability-pipelines-worker/README.md

Installs the chart with the release name <RELEASE_NAME>, setting the Datadog API key, pipeline ID, and the Datadog site using the datadog.site option.

```bash
helm install --name <RELEASE_NAME> \
    --set datadog.apiKey=<DD_API_KEY> \
    --set datadog.pipelineId=<DD_OP_PIPELINE_ID> \
    --set datadog.site=<DATADOG_SITE> \
    datadog/observability-pipelines-worker
```

--------------------------------

### helm install with fullnameOverride to avoid collision

Source: https://github.com/datadog/helm-charts/blob/main/charts/datadog/docs/internal/helm-operator-migration-reference.md

Use this command to install the standalone Datadog operator with a custom Deployment name, bypassing the substring collision logic. The example uses parent release 'datadog' and sets fullnameOverride to 'datadog-operator-standalone'.

```bash
helm install datadog-operator datadog/datadog-operator --set fullnameOverride=datadog-operator-standalone
```

--------------------------------

### Enable Helm-DDA Migration

Source: https://github.com/datadog/helm-charts/blob/main/charts/datadog/templates/NOTES.txt

Example command to upgrade the Datadog Helm release with migration enabled after reviewing preview logs.

```bash
helm upgrade {{ .Release.Name }} datadog/datadog \
    --namespace {{ .Release.Namespace }} \
    -f datadog-values.yaml \
    --set-file datadog.operator.migration.userValues=datadog-values.yaml \
    --set datadog.operator.migration.enabled=true \
    --set datadog.operator.migration.preview=false \
    --set operator.datadogCRDs.keepCrds=true
```

--------------------------------

### Install Datadog CRDs

Source: https://github.com/datadog/helm-charts/blob/main/CONTRIBUTING.md

Command to install the required Datadog CRDs into the local Kubernetes cluster.

```shell
make setup-mapper-crds
```

--------------------------------

### Configure Datadog chart parameters

Source: https://github.com/datadog/helm-charts/blob/main/charts/datadog/README.md

Specify multiple configuration parameters using the --set key=value argument during installation.

```bash
helm install <RELEASE_NAME> \
  --set datadog.apiKey=<DATADOG_API_KEY>,datadog.logLevel=DEBUG \
  datadog/datadog
```

--------------------------------

### Helm Install Older Version Command

Source: https://github.com/datadog/helm-charts/blob/main/charts/private-action-runner/UPGRADING.md

Command to install a specific older version of the chart if needed.

```bash
helm install <release-name> datadog/private-action-runner --version 0.20.1 -f your-values.yaml -n <namespace>
```

--------------------------------

### Configure Custom Scripts via runner.scriptFiles

Source: https://github.com/datadog/helm-charts/blob/main/charts/private-action-runner/README.md

Use the runner.scriptFiles parameter to mount custom scripts in the /home/scriptuser/ directory. This example shows how to define a script file and a corresponding credential file to execute it.

```yaml
runner:
  credentialFiles:
    - fileName: "script.yaml"
      data: |
        schemaId: script-credentials-v1
        runPredefinedScript:
          echoInBash:
            command: ["bash", "/home/scriptuser/hello-from-bash.sh"]
  scriptFiles:
    - fileName: "hello-from-bash.sh"
      data: |
        #!/bin/bash
        echo "Hello World from bash!"
```

--------------------------------

### Verify SecurityContextConstraints resource

Source: https://github.com/datadog/helm-charts/blob/main/charts/private-action-runner/README.md

Run this command to inspect the created SecurityContextConstraints resource.

```bash
kubectl get scc private-action-runner-scc -o yaml
```

--------------------------------

### Install Observability Pipelines Worker chart with existing Secret

Source: https://github.com/datadog/helm-charts/blob/main/charts/observability-pipelines-worker/README.md

Installs the chart using a pre-created Kubernetes Secret for the Datadog API key by setting the datadog.apiKeyExistingSecret value.

```bash
helm install --name <RELEASE_NAME> \
  --set datadog.apiKeyExistingSecret=$DATADOG_SECRET_NAME \
  datadog/observability-pipelines-worker
```

--------------------------------

### Upgrade Helm release with migration preview

Source: https://github.com/datadog/helm-charts/blob/main/charts/datadog/docs/Migration_Helm_to_Operator.md

Run this Helm upgrade command to apply the migration preview configuration. Provide the path to your updated datadog-values.yaml file using --set-file.

```shell
helm upgrade <DATADOG_RELEASE_NAME> \
   --set-file datadog.operator.migration.userValues=datadog-values.yaml \
   -f datadog-values.yaml \
   datadog/datadog

```