Skip to content

docs: improve navigation for Supervisor Services #20

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
fstrudel wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: improve navigation for Supervisor Services #20

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 documentation/element-types/supervisor-service.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ A `SupervisorService` installs and manages a [Carvel](https://carvel.dev/) packa

## When to Use

- Deploy a Carvel-packaged application (e.g. Arcturus, TKG, Prometheus) to one or more Supervisor clusters.
- Deploy a Carvel-packaged application (e.g. Arcturus, VKS, Prometheus) to one or more Supervisor clusters.
- Automate multi-region Supervisor service deployment with consistent configuration.

## Spec Fields
Expand Down
2 changes: 2 additions & 0 deletions documentation/overview.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -122,6 +122,8 @@ The lifecycle section describes how to create, distribute, and operate a VCF Ser

### I have an existing Supervisor Service and want to bring it into VCF Automation

If you have not yet built your Supervisor Service, start with the [Supervisor Services Development Guide](supervisor-services/overview.md) first, then return here.

1. Your Supervisor Service bundle becomes the value of the `spec.package` field (or a selector pointing to a ConfigMap) inside a [`SupervisorService`](element-types/supervisor-service.md) CR.
2. That CR lives inside a VCF Service bundle alongside any other CRs your service needs (RBAC, UI plugin, API extension, etc.).
3. Follow the [Packaging and Distribution](lifecycle/packaging-and-build.md) guide to wrap everything into a VCF Service tarball.
Expand Down