Skip to content

Commit c80f32f

Browse files
daniel-de-veradaniel-de-vera
authored
Merge pull request #49 from signadot/update-values-and-readme
Update values, readme and rbac
2 parents 23538c9 + 7798623 commit c80f32f

File tree

3 files changed

+139
-19
lines changed

3 files changed

+139
-19
lines changed

‎signadot/operator/README.md‎

Lines changed: 69 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,9 @@
33
This chart installs Signadot Operator, which consists of the in-cluster
44
components for Signadot.
55

6-
## Installation
6+
## Installing the Chart
7+
8+
To install the chart with the release name `signadot-operator`:
79

810
```sh
911
# Create signadot namespace
@@ -12,27 +14,84 @@ kubectl create ns signadot
1214
# Install
1315
helm repo add signadot https://charts.signadot.com
1416
helm install signadot-operator signadot/operator
17+
```
18+
The command deploys Signadot Operator on the Kubernetes cluster with default configuration. The [Parameters](#parameters) section lists the parameters that can be configured during installation.
19+
20+
21+
## Cluster Registration
22+
23+
In addition to installing this chart, the cluster must also be registered
24+
in the [Signadot dashboard](https://app.signadot.com).
25+
26+
After generating a cluster token, complete the registration by populating a Secret
27+
called `cluster-agent` in the `signadot` namespace:
28+
29+
```sh
30+
# Replace "..." with the token value.
31+
kubectl -n signadot create secret generic cluster-agent --from-literal=token=...
32+
```
33+
34+
## Upgrading the Chart
1535

36+
To upgrade an existing `signadot-operator` deployment:
37+
38+
```sh
1639
# Upgrade
1740
helm repo update
1841
helm upgrade signadot-operator signadot/operator
42+
```
43+
44+
## Uninstalling the Chart
1945

46+
To uninstall/delete the `signadot-operator` deployment:
47+
48+
```sh
2049
# Uninstall
2150
helm uninstall signadot-operator
2251

2352
# Remove signadot namespace
2453
kubectl delete ns signadot
2554
```
2655

27-
## Cluster Registration
56+
## Parameters
2857

29-
In addition to installing this chart, the cluster must also be registered
30-
in the [Signadot dashboard](https://app.signadot.com).
58+
### Common parameters
3159

32-
After generating a cluster token, complete the registration by populating a Secret
33-
called `cluster-agent` in the `signadot` namespace:
60+
| Name | Description | Default |
61+
| -------------------- | --------------------------------------------------------- | -------- |
62+
| `commonLabels` | Labels to add to all deployed objects | `{}` |
63+
| `commonAnnotations` | Annotations to add to all deployed objects | `{}` |
64+
| `podLabels` | Labels to add to all deployed `Pod` objects | `{}` |
65+
| `podAnnotations` | Annotations to add to all deployed `Pod` objects | `{}` |
66+
| `serviceLabels` | Labels to add to all deployed `Service` objects | `{}` |
67+
| `serviceAnnotations` | Annotations to add to all deployed `Service` objects | `{}` |
3468

35-
```sh
36-
# Replace "..." with the token value.
37-
kubectl -n signadot create secret generic cluster-agent --from-literal=token=...
38-
```
69+
### Image customization parameters
70+
71+
| Name | Description | Default |
72+
| --------------------------------- | ---------------------------------------------- | ---------------- |
73+
| `operator.image` | Operator image override | `""` |
74+
| `operator.imagePullPolicy` | Operator image pull policy | `IfNotPresent` |
75+
| `agent.image` | Agent image override | `""` |
76+
| `agent.imagePullPolicy` | Agent image pull policy | `IfNotPresent` |
77+
| `routeServer.image` | Route Server image override | `""` |
78+
| `routeServer.imagePullPolicy` | Route Server image pull policy | `IfNotPresent` |
79+
| `ioContextServer.image` | IO Context Server image override | `""` |
80+
| `ioContextServer.imagePullPolicy` | IO Context Server image pull policy | `IfNotPresent` |
81+
| `kubeRBACProxy.image` | Kube-rbac-proxy image override | `""` |
82+
| `kubeRBACProxy.imagePullPolicy` | Kube-rbac-proxy image pull policy | `IfNotPresent` |
83+
| `routeInit.image` | Route Init container image override | `""` |
84+
| `routeInit.imagePullPolicy` | Route Init container image pull policy | `IfNotPresent` |
85+
| `routeInit.imagePullSecret` | Route Init container image pull secret | `""` |
86+
| `routeSidecar.image` | Route Sidecar container image override | `""` |
87+
| `routeSidecar.imagePullPolicy` | Route Sidecar container image pull policy | `IfNotPresent` |
88+
| `routeSidecar.imagePullSecret` | Route Sidecar container image pull secret | `""` |
89+
| `ioInit.image` | IO Init container image override | `""` |
90+
| `ioInit.imagePullPolicy` | IO Init container image pull policy | `IfNotPresent` |
91+
| `ioInit.imagePullSecret` | IO Init container image pull secret | `""` |
92+
| `ioSidecar.image` | IO Sidecar container image override | `""` |
93+
| `ioSidecar.imagePullPolicy` | IO Sidecar container image pull policy | `IfNotPresent` |
94+
| `ioSidecar.imagePullSecret` | IO Sidecar container image pull secret | `""` |
95+
| `execpodSidecar.image` | ExecPod Sidecar container image override | `""` |
96+
| `execpodSidecar.imagePullPolicy` | ExecPod Sidecar container image pull policy | `IfNotPresent` |
97+
| `execpodSidecar.imagePullSecret` | ExecPod Sidecar container image pull secret | `""`

‎signadot/operator/templates/signadot-agent-clusterrole.yaml‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,8 @@ rules:
1919
- signadotsandboxes
2020
- signadotroutes
2121
- signadotresources
22+
- resources
23+
- signadotobjectlifecyclemethods
2224
- signadotresourceplugins
2325
- signadotroutegroups
2426
verbs:

‎signadot/operator/values.yaml‎

Lines changed: 68 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,79 @@
1-
# # Add these labels to all Pods deployed by this chart.
2-
# podLabels:
3-
# examplePodLabel: PLvalue
4-
5-
# # Add these labels to all objects deployed by this chart.
1+
# Add these labels to all objects deployed by this chart.
62
# commonLabels:
73
# exampleCommonLabel: exampleCommonLabelValue
84

9-
# # Add these annotations to all objects deployed by this chart.
5+
# Add these annotations to all objects deployed by this chart.
106
# commonAnnotations:
117
# exampleCommonAnnotation: exampleCommonAnnotationValue
128

9+
# Add these labels to all Pods deployed by this chart.
10+
# podLabels:
11+
# examplePodLabel: examplePodLabelValue
12+
13+
# Add these annotations to all Pods deployed by this chart.
14+
# podAnnotations:
15+
# examplePodLAnnotation: examplePodLAnnotationValue
16+
17+
# Add these labels to all Services deployed by this chart.
18+
# serviceLabels:
19+
# exampleServiceLabel: exampleServiceLabelValue
20+
21+
# Add these annotations to all Services deployed by this chart.
22+
# serviceAnnotations:
23+
# exampleServiceLAnnotation: exampleServiceLAnnotationValue
24+
1325
# By default, this chart will install the operator in
1426
# cluster-wide mode, where it watches all namespaces.
15-
#
27+
1628
# Uncomment the following to configure the operator to
1729
# only watch specific namespaces.
18-
#
1930
# allowedNamespaces:
20-
# - example
31+
# - ns1
32+
# - ns2
33+
34+
# Image customization parameters:
35+
#
36+
# operator:
37+
# image: my-private-registry/signadot/operator:latest
38+
# imagePullPolicy: Always
39+
40+
# agent:
41+
# image: my-private-registry/signadot/agent:latest
42+
# imagePullPolicy: Always
43+
44+
# routeServer:
45+
# image: my-private-registry/signadot/route-server:latest
46+
# imagePullPolicy: Always
47+
48+
# ioContextServer:
49+
# image: my-private-registry/signadot/io-context-server:latest
50+
# imagePullPolicy: Always
51+
52+
# kubeRBACProxy:
53+
# image: my-private-registry/gcr.io/kubebuilder/kube-rbac-proxy:v0.8.0
54+
# imagePullPolicy: Always
55+
56+
# routeInit:
57+
# image: my-private-registry/signadot/sd-init-networking:latest
58+
# imagePullPolicy: Always
59+
# imagePullSecret: secret-routeInit
60+
61+
# routeSidecar:
62+
# image: my-private-registry/signadot/route-sidecar:latest
63+
# imagePullPolicy: Always
64+
# imagePullSecret: secret-routeSidecar
65+
66+
# ioInit:
67+
# image: my-private-registry/signadot/io-init:latest
68+
# imagePullPolicy: Always
69+
# imagePullSecret: secret-ioInit
70+
71+
# ioSidecar:
72+
# image: my-private-registry/signadot/io-sidecar:latest
73+
# imagePullPolicy: Always
74+
# imagePullSecret: secret-ioSidecar
75+
76+
# execpodSidecar: # for legacy resource plugins
77+
# image: my-private-registry/signadot/execpod-sidecar:latest
78+
# imagePullPolicy: Always
79+
# imagePullSecret: secret-execpodSidecar

0 commit comments

Comments
 (0)