Skip to content

Commit 9360253

Browse files
authored
Merge pull request #6 from xrstf/helm-docs
add docs on how to use init-agent in an kcp-operator managed kcp
2 parents ede7fbc + b9189ef commit 9360253

File tree

6 files changed

+363
-31
lines changed

6 files changed

+363
-31
lines changed

docs/content/.pages

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
nav:
22
- Documentation:
33
- README.md
4-
- setup.md
54
- readiness.md
65
- faq.md
6+
- Setup: setup
77
- Init Sources: init-sources
88
- Reference: reference
99
- Contributing: contributing

docs/content/readiness.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ individual manifests.
1010

1111
## How It Works
1212

13-
When the init-agent encounters a manifest (from any of its [init sources](./init-sources/)) with
13+
When the init-agent encounters a manifest (from any of its [init sources](init-sources/README.md)) with
1414
the `initialization.kcp.io/wait-for-ready` annotation, it will:
1515

1616
1. Create (or confirm the existence of) the object as usual.

docs/content/setup/.pages

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
nav:
2+
- README.md
3+
- development.md
4+
- production.md

docs/content/setup/README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# Setting up the Init Agent
2+
3+
This chapter describes different methods of installing the init-agent.
4+
5+
## Overview
6+
7+
* [Development](development.md) is a quick-ish setup suitable for hacking and
8+
quick tests.
9+
* [Production](production.md) is geared more towards a production environment,
10+
managed by the kcp-operator.
Lines changed: 1 addition & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Installing the Init Agent
1+
# Development Setup
22

33
This page describes the necessary steps to setup the Init Agent for an existing [kcp][kcp] installation.
44

@@ -152,34 +152,6 @@ spec:
152152

153153
## Running the Agent
154154

155-
For regular use, the init-agent should be installed using its [Helm chart][helmchart], but for
156-
debugging purposes it's also possible to run the agent locally.
157-
158-
### Helm Chart
159-
160-
To use the Helm chart, first add the repository to your local system:
161-
162-
```bash
163-
helm repo add kcp https://kcp-dev.github.io/helm-charts
164-
helm repo update
165-
```
166-
167-
At the very least you will have to provide
168-
169-
* a kubeconfig to access kcp
170-
* the name of the workspace/cluster where the `InitTargets` and other resources
171-
reside
172-
173-
Put both in your `myvalues.yaml` (check the `values.yaml` for more examples).
174-
175-
You can now install the chart:
176-
177-
```bash
178-
helm upgrade --install my-init-agent kcp/init-agent --values ./myvalues.yaml
179-
```
180-
181-
### Locally
182-
183155
For development purposes you can run the agent directly. You can build your own from
184156
source or download one of the [ready-made releases][releases]. To run it, you need
185157
to provide the kcp kubeconfig and the workspace/cluster where the `InitTargets`

0 commit comments

Comments
 (0)