Skip to content

Update documentation for generating manifests #6053

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

Merged
merged 4 commits into from
Oct 18, 2022
Merged

Update documentation for generating manifests #6053

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
d87f2f4
update docs for generating manifests
everettraven Oct 4, 2022
bb80c89
update to provide examples
everettraven Oct 4, 2022
68dd4c6
update missed manifests/kustomization reference
everettraven Oct 4, 2022
ee8dd7f
updates from review comments
everettraven Oct 17, 2022
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
26 changes: 22 additions & 4 deletions website/content/en/docs/olm-integration/generation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,11 +23,11 @@ See this [CLI overview][cli-overview] for details on each command.
### Kustomize files

`operator-sdk generate kustomize manifests` generates a CSV kustomize base
`config/manifests/bases/<project-name>.clusterserviceversion.yaml` and a `config/manifests/bases/kustomization.yaml`
`config/manifests/bases/<project-name>.clusterserviceversion.yaml` and a `config/manifests/kustomization.yaml`
by default. These files are required as `kustomize build` input in downstream commands.

By default, the command starts an interactive prompt if a CSV base in `config/manifests/bases` is not present
to collect [UI metadata](#csv-fields). You can disable the interactive prompt by passing `--kustomize=false`.
to collect [UI metadata](#csv-fields). You can disable the interactive prompt by passing `--interactive=false`.

```console
$ operator-sdk generate kustomize manifests
Expand All @@ -47,7 +47,25 @@ These values will persist when generating a bundle, so make necessary metadata c
**For Go Operators only:** the command parses [CSV markers][csv-markers] from Go API type definitions, located
in `./api` for single group projects and `./apis` for multigroup projects, to populate certain CSV fields.
You can set an alternative path to the API types root directory with `--apis-dir`. These markers are not available
to Ansible or Helm project types.
to Ansible or Helm project types.

The command attempts to process the local types defined in your API.
If you import a package that uses the same name as a local type, running the command causes an infinite loop. For example:
```go
type PodStatus struct {
SomeField string
// imported type with the same name will infinitely trigger
// the parser to process the local PodStatus type
Status v1.PodStatus
}
```
To prevent an infinite loop, edit the local type definition to use a different name. For example:
```go
type PodStatusWrapper struct {
SomeField string
Status v1.PodStatus
}
```

### ClusterServiceVersion manifests

Expand All @@ -57,7 +75,7 @@ themselves; this version is present in both their `metadata.name` and `spec.vers
by `generate <bundle|packagemanifests>` requires certain input manifests to construct a CSV manifest; all inputs
are read when either command is invoked, along with a CSV's [base](#kustomize-files), to idempotently regenerate a CSV.

The following resource kinds are typically included in a CSV, which are addressed by `config/manifests/bases/kustomization.yaml`:
The following resource kinds are typically included in a CSV, which are addressed by `config/manifests/kustomization.yaml`:
- `Role`: define Operator permissions within a namespace.
- `ClusterRole`: define cluster-wide Operator permissions.
- `Deployment`: define how the Operator's operand is run in pods.
Expand Down