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: 9 additions & 5 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,8 @@ verify-charts:
arkade chart verify --verbose=$(VERBOSE) -f ./chart/postgres-connector/values.yaml && \
arkade chart verify --verbose=$(VERBOSE) -f ./chart/queue-worker/values.yaml && \
arkade chart verify --verbose=$(VERBOSE) -f ./chart/sns-connector/values.yaml && \
arkade chart verify --verbose=$(VERBOSE) -f ./chart/rabbitmq-connector/values.yaml
arkade chart verify --verbose=$(VERBOSE) -f ./chart/rabbitmq-connector/values.yaml && \
arkade chart verify --verbose=$(VERBOSE) -f ./chart/headroom-controller/values.yaml

verify-chart:
@echo Verifying helm chart images in remote registries && \
Expand All @@ -109,7 +110,8 @@ upgrade-charts:
arkade chart upgrade --verbose=$(VERBOSE) -w -f ./chart/postgres-connector/values.yaml && \
arkade chart upgrade --verbose=$(VERBOSE) -w -f ./chart/queue-worker/values.yaml && \
arkade chart upgrade --verbose=$(VERBOSE) -w -f ./chart/sns-connector/values.yaml && \
arkade chart upgrade --verbose=$(VERBOSE) -w -f ./chart/rabbitmq-connector/values.yaml
arkade chart upgrade --verbose=$(VERBOSE) -w -f ./chart/rabbitmq-connector/values.yaml && \
arkade chart upgrade --verbose=$(VERBOSE) -w -f ./chart/headroom-controller/values.yaml

bump-charts:
arkade chart bump --file ./chart/openfaas/Chart.yaml -w && \
Expand All @@ -122,8 +124,9 @@ bump-charts:
arkade chart bump --file ./chart/postgres-connector/Chart.yaml -w && \
arkade chart bump --file ./chart/queue-worker/Chart.yaml -w && \
arkade chart bump --file ./chart/sns-connector/Chart.yaml -w && \
arkade chart bump --file ./chart/rabbitmq-connector/Chart.yaml -w

arkade chart bump --file ./chart/rabbitmq-connector/Chart.yaml -w && \
arkade chart bump --file ./chart/headroom-controller/Chart.yaml -w

charts-only:
@cd chart && \
helm package openfaas/ && \
Expand All @@ -136,7 +139,8 @@ charts-only:
helm package postgres-connector/ && \
helm package queue-worker/ && \
helm package sns-connector/ && \
helm package rabbitmq-connector/
helm package rabbitmq-connector/ && \
helm package headroom-controller/
mv chart/*.tgz docs/
helm repo index docs --url https://openfaas.github.io/faas-netes/ --merge ./docs/index.yaml

Expand Down
19 changes: 19 additions & 0 deletions chart/headroom-controller/Chart.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
apiVersion: v2
name: headroom-controller
description: A Helm chart for headroom-controller - Kubernetes resource reservation controller
type: application
version: 0.1.0
appVersion: "0.1.0"
keywords:
- kubernetes
- resource-management
- autoscaling
home: https://github.com/openfaas/faas-netes/chart/headroom-controller/README.md
sources:
- https://github.com/openfaas/faas-netes
icon: https://raw.githubusercontent.com/openfaas/media/master/OpenFaaS_logo_stacked_opaque.png
maintainers:
- name: alexellis
email: [email protected]
- name: welteki
email: [email protected]
124 changes: 124 additions & 0 deletions chart/headroom-controller/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,124 @@
# Headroom Controller Helm Chart

A Helm chart for deploying the headroom-controller controller, which manages Kubernetes resource reservations through custom Headroom resources.

## Prerequisites

- Kubernetes 1.19+
- Helm 3.0+

## Installation

### Add the repository

```bash
helm repo add headroom-controller https://openfaas.github.io/faas-netes/
helm repo update

# Install the chart
helm upgrade headroom-controller \
--install openfaas/headroom-controller \
--namespace default
```

### Install from local chart

If you are working on a patch for the helm chart, you can deploy it directly from a local folder.

```bash
# Clone the repository
git clone https://github.com/openfaas/faas-netes.git
cd headroom-controller

# Install the chart
helm upgrade install headroom-controller \
--install./chart/headroom-controller \
--namespace default
```

## Usage

After installation, you can create Headroom resources:

```bash
kubectl apply -f - <<EOF
apiVersion: openfaas.com/v1
kind: Headroom
metadata:
name: example
spec:
replicas: 1
requests:
cpu: "100m"
memory: "128Mi"
priorityClassName: "headroom"
EOF
```

### Check status

```bash
kubectl get headrooms
```

### Scale headroom

```bash
kubectl scale headroom example --replicas=2
```

### Install with custom values

```bash
helm upgrade install headroom-controller \
--install openfaas/headroom-controller \
--namespace default \
--set rbac.role=ClusterRole \
--set replicaCount=2
```

## Configuration

Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`.

See [values.yaml](./values.yaml) for detailed configuration.

| Parameter | Description | Default |
|-----------|-------------|---------|
| `replicaCount` | Number of controller replicas | `1` |
| `image` | Container image | See [values.yaml](./values.yaml) |
| `imagePullPolicy` | Image pull policy | `IfNotPresent` |
| `imagePullSecrets` | Image pull secrets | `[]` |
| `nameOverride` | Override chart name | `""` |
| `fullnameOverride` | Override full chart name | `""` |
| `rbac.create` | Create RBAC resources | `true` |
| `rbac.role` | Role type (Role or ClusterRole) | `ClusterRole` |
| `serviceAccount.create` | Create service account | `true` |
| `serviceAccount.annotations` | Service account annotations | `{}` |
| `serviceAccount.name` | Service account name | `""` |
| `podAnnotations` | Pod annotations | `{}` |
| `podSecurityContext` | Pod security context | `{}` |
| `securityContext` | Container security context | `{}` |
| `resources.limits.cpu` | CPU limit | `250m` |
| `resources.limits.memory` | Memory limit | `256Mi` |
| `resources.requests.cpu` | CPU request | `50m` |
| `resources.requests.memory` | Memory request | `64Mi` |
| `nodeSelector` | Node selector for pod assignment | `{}` |
| `tolerations` | Tolerations for pod assignment | `[]` |
| `affinity` | Affinity rules for pod assignment | `{}` |
| `metrics.enabled` | Enable metrics collection | `false` |
| `leaderElection.enabled` | Enable leader election | `true` |
| `leaderElection.namespace` | Namespace for leader election | `"default"` |
| `logging.level` | Log level | `info` |

## Uninstalling

```bash
helm uninstall headroom-controller
```

Note: This will not remove the CRDs. To remove them:

```bash
kubectl delete crd headrooms.openfaas.com
```
Loading
Loading