Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions .github/workflows/publish-chart.yml
Original file line number Diff line number Diff line change
@@ -1,14 +1,24 @@
name: Release Helm Chart

on:
release:
types:
- published
push:
branches:
- main
tags:
- 'v*.*.*'
paths-ignore:
- 'docs/**'
- '**/*.md'
pull_request:
branches:
- main
paths-ignore:
- 'docs/**'
- '**/*.md'
types: [labeled, opened, synchronize, reopened]

jobs:
helm-chart:
Expand All @@ -17,6 +27,10 @@ jobs:
contents: read
packages: write

if: |
github.event_name == 'push' ||
(github.event_name == 'pull_request' && contains(github.event.pull_request.labels.*.name, 'ok-to-charts')) ||
(github.event_name == 'release' && github.event.action == 'published')
steps:
- name: Checkout code
uses: actions/checkout@v4
Expand Down
28 changes: 14 additions & 14 deletions docs/usage/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,21 +39,21 @@ The `values.yaml` file allows you to configure various aspects of the Metal Oper

### Controller Manager

| Key | Description | Default Value |
|------------------------------------|-----------------------------------------------------------------------------|--------------------------------|
| `controllerManager.replicas` | Number of replicas for the manager deployment | `1` |
| `controllerManager.container.image.repository` | Image repository for the manager container | `registry/metal-operator` |
| `controllerManager.container.image.tag` | Image tag for the manager container | `"v0.1.0"` |
| `controllerManager.container.args` | Arguments for the manager container | `--probe-image=probe-image`, `--probe-os-image=probe-os-image`, `--registry-url=registry-url` |
| `controllerManager.container.resources` | Resource requests and limits for the manager container | `{cpu: 500m, memory: 128Mi}` (limits), `{cpu: 10m, memory: 64Mi}` (requests) |
| `controllerManager.container.livenessProbe` | Liveness probe configuration for the manager container | `{initialDelaySeconds: 15, periodSeconds: 20, httpGet: {path: /healthz, port: 8081}}` |
| `controllerManager.container.readinessProbe` | Readiness probe configuration for the manager container | `{initialDelaySeconds: 5, periodSeconds: 10, httpGet: {path: /readyz, port: 8081}}` |
| `controllerManager.container.securityContext` | Security context for the manager container | `{allowPrivilegeEscalation: false, capabilities: {drop: ["ALL"]}}` |
| `controllerManager.securityContext` | Security context for the manager pod | `{runAsNonRoot: true, seccompProfile: {type: RuntimeDefault}}` |
| Key | Description | Default Value |
|---------------------------------------------------|-----------------------------------------------------------------------------|--------------------------------|
| `controllerManager.replicas` | Number of replicas for the manager deployment | `1` |
| `controllerManager.strategy.type` | Deployment strategy for the manager pod | `Recreate` |
| `controllerManager.manager.image.repository` | Image repository for the manager container | `controller` |
| `controllerManager.manager.image.tag` | Image tag for the manager container | `latest` |
| `controllerManager.manager.args` | Arguments for the manager container | `--leader-elect`, `--metrics-bind-address=:8443`, `--health-probe-bind-address=:8081` |
| `controllerManager.manager.resources` | Resource requests and limits for the manager container | `{cpu: 300m, memory: 200Mi}` (limits), `{cpu: 300m, memory: 50Mi}` (requests) |
| `controllerManager.manager.livenessProbe` | Liveness probe configuration for the manager container | `{initialDelaySeconds: 15, periodSeconds: 20, httpGet: {path: /healthz, port: 8081}}` |
| `controllerManager.manager.readinessProbe` | Readiness probe configuration for the manager container | `{initialDelaySeconds: 5, periodSeconds: 10, httpGet: {path: /readyz, port: 8081}}` |
| `controllerManager.manager.securityContext` | Security context for the manager container | `{allowPrivilegeEscalation: false, capabilities: {drop: ["ALL"]}}` |
| `controllerManager.podSecurityContext` | Security context for the manager pod | `{runAsNonRoot: true, seccompProfile: {type: RuntimeDefault}}` |
| `controllerManager.terminationGracePeriodSeconds` | Termination grace period for the manager pod | `10` |
| `controllerManager.serviceAccountName` | Service account name for the manager pod | `metal-operator-controller-manager` |
| `controllerManager.nodeSelector` | Node selector for the manager pod | `{kubernetes.io/os: linux, kubernetes.io/arch: arm64}` |
| `controllerManager.tolerations` | Tolerations for the manager pod | `[{key: node-role.kubernetes.io/control-plane, effect: NoSchedule}]` |
| `controllerManager.serviceAccountName` | Service account name for the manager pod | `metal-operator-controller-manager` |
| `controllerManager.hostNetwork` | Enable host networking for the manager pod | `true` |

- **rbac**: Enable or disable RBAC.
- **crd**: Enable or disable CRDs.
Expand Down
Loading