Skip to content

docs: Add page descriptions #771

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

docs: Add page descriptions #771

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
1 change: 1 addition & 0 deletions docs/modules/secret-operator/pages/installation.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
= Installation
:description: Installation of the Stackable secret operator with Helm, covering the settings for Kubernetes distributions such as MicroK8s, k0s and VMware Tanzu.

There are two ways to run the Stackable Secret Operator:

Expand Down
1 change: 1 addition & 0 deletions docs/modules/secret-operator/pages/reference/commandline-parameters.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
= Command line parameters
:description: Command-line parameters the Stackable secret operator accepts, such as the required CSI endpoint socket path, with their environment variable equivalents.

This operator accepts the following command line parameters:

Expand Down
1 change: 1 addition & 0 deletions docs/modules/secret-operator/pages/reference/crds.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
= CRD Reference
:description: CRD reference for the Stackable secret operator on the Stackable Hub, covering every field, default and API version.

Find all CRD reference for the Stackable Secret Operator at: {crd-ref}{crd-ref-release}&operator=secret-operator.
1 change: 1 addition & 0 deletions docs/modules/secret-operator/pages/reference/environment-variables.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
= Environment variables
:description: Environment variables the Stackable secret operator accepts, including the required CSI endpoint socket, with what each one controls and its default.

This operator accepts the following environment variables:

Expand Down
1 change: 1 addition & 0 deletions docs/modules/secret-operator/pages/reference/index.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
= Reference
:description: Reference for the Stackable secret operator, covering CRD fields, command-line parameters and environment variables, with their default values.

Consult the reference documentation section to find exhaustive information on:

Expand Down
1 change: 1 addition & 0 deletions docs/modules/secret-operator/pages/troubleshooting.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
= Troubleshooting
:description: Troubleshooting the Stackable secret operator, covering Pods stuck pending on secret volumes, PersistentVolumeClaim problems and Active Directory conflicts.

[#general]
== General
Expand Down
1 change: 1 addition & 0 deletions docs/modules/secret-operator/pages/usage.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
= Usage
:description: Usage of the Stackable secret operator in other Pods through ephemeral volumes, and when a SecretClass on a stacklet is the better fit.

The operator injects secret data into xref:volume.adoc[] mounts that declare an ephemeral volume with `storageClassName: secrets.stackable.tech`.

Expand Down
Loading