Skip to content

add docs on how to use init-agent in an kcp-operator managed kcp #6

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
xrstf wants to merge 1 commit into
base: main
Choose a base branch
from
Open

add docs on how to use init-agent in an kcp-operator managed kcp #6

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion docs/content/.pages
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
nav:
- Documentation:
- README.md
- setup.md
- readiness.md
- faq.md
- Setup: setup
- Init Sources: init-sources
- Reference: reference
- Contributing: contributing
4 changes: 4 additions & 0 deletions docs/content/setup/.pages
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
nav:
- README.md
- development.md
- production.md
10 changes: 10 additions & 0 deletions docs/content/setup/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# Setting up the Init Agent

This chapter describes different methods of installing the init-agent.

## Overview

* [Development](development.md) is a quick-ish setup suitable for hacking and
quick tests.
* [Production](production.md) is geared more towards a production environment,
managed by the kcp-operator.
30 changes: 1 addition & 29 deletions docs/content/setup.md → docs/content/setup/development.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Installing the Init Agent
# Development Setup

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

Expand Down Expand Up @@ -152,34 +152,6 @@ spec:

## Running the Agent

For regular use, the init-agent should be installed using its [Helm chart][helmchart], but for
debugging purposes it's also possible to run the agent locally.

### Helm Chart

To use the Helm chart, first add the repository to your local system:

```bash
helm repo add kcp https://kcp-dev.github.io/helm-charts
helm repo update
```

At the very least you will have to provide

* a kubeconfig to access kcp
* the name of the workspace/cluster where the `InitTargets` and other resources
reside

Put both in your `myvalues.yaml` (check the `values.yaml` for more examples).

You can now install the chart:

```bash
helm upgrade --install my-init-agent kcp/init-agent --values ./myvalues.yaml
```

### Locally

For development purposes you can run the agent directly. You can build your own from
source or download one of the [ready-made releases][releases]. To run it, you need
to provide the kcp kubeconfig and the workspace/cluster where the `InitTargets`
Expand Down
Loading