|
2 | 2 |
|
3 | 3 | [](https://www.apache.org/licenses/LICENSE-2.0) |
4 | 4 |
|
5 | | -This repository contains varous components for running Kubernetes on STACKIT. |
| 5 | +This repository contains varous components for running Kubernetes on STACKIT. |
6 | 6 | This provider allows your Kubernetes cluster to integrate directly with STACKIT APIs. |
7 | 7 |
|
8 | 8 | ## Features |
| 9 | + |
9 | 10 | This repository hosts the following components: |
| 11 | + |
10 | 12 | - Cloud Controller Manager (CCM) |
11 | 13 | - STACKIT CSI driver |
12 | 14 | - Kubernetes Resources for the Manager |
13 | 15 | - Ginko bootstrapped Test Suite |
14 | 16 |
|
15 | 17 | Does not include: |
16 | 18 |
|
17 | | -- readyz and healthz |
| 19 | +- `readyz` and `healthz` |
18 | 20 | - Kubernetes Client with self authorization by `inClusterConfig` |
19 | 21 |
|
20 | | -## Operations |
21 | | - |
22 | | -- Required: STACKIT-specific settings have to be set using a cloud config via `--cloud-config=config.yaml`. |
23 | | - |
24 | | -```yaml |
25 | | -# config.yaml |
26 | | -projectId: |
27 | | -networkId: |
28 | | -region: eu01 |
29 | | -``` |
30 | | -
|
31 | | -- Required: STACKIT authentication for SDK |
32 | | - - To authenticate against the STACKIT API follow [STACKIT SDK authentication](https://github.com/stackitcloud/stackit-sdk-go#authentication). The cloud controller manager supports all authentication methods that are supported by the SDK. |
33 | | -- Service metrics are available at `https://:10258/metrics`. To allow unauthorized access add `--authorization-always-allow-paths=/metrics`. |
34 | | -- Load Balancer metrics can be sent to a remote write endpoint (e.g. STACKIT observability). To use this feature all the following environment variables need to be set: |
35 | | - - `STACKIT_REMOTEWRITE_ENDPOINT` the remote write push URL to send the metrics to |
36 | | - - `STACKIT_REMOTEWRITE_USER` the basic auth username |
37 | | - - `STACKIT_REMOTEWRITE_PASSWORD` the basic auth password |
38 | | - - If none of these environment variables are set, this feature is ignored and no Load Balancer metrics are sent. |
39 | | - |
40 | 22 | ## User Documentation |
41 | 23 |
|
42 | | -- [Load Balancer](docs/load-balancer.md) |
43 | | -- [CSI Driver](docs/csi-driver.md) |
| 24 | +- Usage |
| 25 | + - [Load Balancer](docs/load-balancer.md) |
| 26 | + - [CSI Driver](docs/csi-driver.md) |
| 27 | +- Administration |
| 28 | + - [Deployment](docs/deployment.md) |
| 29 | +- Development |
| 30 | + - [Testing](docs/testing.md) |
| 31 | + - [Release Procedure](docs/release-procedure.md) |
0 commit comments