Skip to content

CORENET-6714 Adding documentation #2907

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
OlivierCazade wants to merge 1 commit into
base: master
Choose a base branch
from
+26 −2
Open

CORENET-6714 Adding documentation #2907

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
3 changes: 3 additions & 0 deletions config/v1/types_network.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -331,6 +331,9 @@ type NetworkObservabilitySpec struct {
// Valid values are "InstallAndEnable" and "NoAction".
// When set to "InstallAndEnable", ensure that network observability will be installed and enabled on the cluster. If already installed, no action taken, but if it gets uninstalled, it will install it again.
// When set to "NoAction", nothing will be done regarding Network observability.
// During the installation of NetworkObservability, the platform checks for any existing manual installations.
// If a successful installation using the OLMv0 or OLMv1 API is detected, it will be used.
// If the platform cannot determine how the current version was installed, or if the existing installation is incomplete, the installation process will stop.
// +required
InstallationPolicy NetworkObservabilityInstallationPolicy `json:"installationPolicy,omitempty"`
}
3 changes: 3 additions & 0 deletions ...1/zz_generated.crd-manifests/0000_10_config-operator_01_networks-CustomNoUpgrade.crd.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -273,6 +273,9 @@ spec:
Valid values are "InstallAndEnable" and "NoAction".
When set to "InstallAndEnable", ensure that network observability will be installed and enabled on the cluster. If already installed, no action taken, but if it gets uninstalled, it will install it again.
When set to "NoAction", nothing will be done regarding Network observability.
During the installation of NetworkObservability, the platform checks for any existing manual installations.
If a successful installation using the OLMv0 or OLMv1 API is detected, it will be used.
If the platform cannot determine how the current version was installed, or if the existing installation is incomplete, the installation process will stop.
enum:
- InstallAndEnable
- NoAction
Expand Down
3 changes: 3 additions & 0 deletions ..._generated.crd-manifests/0000_10_config-operator_01_networks-DevPreviewNoUpgrade.crd.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -273,6 +273,9 @@ spec:
Valid values are "InstallAndEnable" and "NoAction".
When set to "InstallAndEnable", ensure that network observability will be installed and enabled on the cluster. If already installed, no action taken, but if it gets uninstalled, it will install it again.
When set to "NoAction", nothing will be done regarding Network observability.
During the installation of NetworkObservability, the platform checks for any existing manual installations.
If a successful installation using the OLMv0 or OLMv1 API is detected, it will be used.
If the platform cannot determine how the current version was installed, or if the existing installation is incomplete, the installation process will stop.
enum:
- InstallAndEnable
- NoAction
Expand Down
3 changes: 3 additions & 0 deletions ...generated.crd-manifests/0000_10_config-operator_01_networks-TechPreviewNoUpgrade.crd.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -273,6 +273,9 @@ spec:
Valid values are "InstallAndEnable" and "NoAction".
When set to "InstallAndEnable", ensure that network observability will be installed and enabled on the cluster. If already installed, no action taken, but if it gets uninstalled, it will install it again.
When set to "NoAction", nothing will be done regarding Network observability.
During the installation of NetworkObservability, the platform checks for any existing manual installations.
If a successful installation using the OLMv0 or OLMv1 API is detected, it will be used.
If the platform cannot determine how the current version was installed, or if the existing installation is incomplete, the installation process will stop.
enum:
- InstallAndEnable
- NoAction
Expand Down
3 changes: 3 additions & 0 deletions ....featuregated-crd-manifests/networks.config.openshift.io/NetworkObservabilityInstall.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -273,6 +273,9 @@ spec:
Valid values are "InstallAndEnable" and "NoAction".
When set to "InstallAndEnable", ensure that network observability will be installed and enabled on the cluster. If already installed, no action taken, but if it gets uninstalled, it will install it again.
When set to "NoAction", nothing will be done regarding Network observability.
During the installation of NetworkObservability, the platform checks for any existing manual installations.
If a successful installation using the OLMv0 or OLMv1 API is detected, it will be used.
If the platform cannot determine how the current version was installed, or if the existing installation is incomplete, the installation process will stop.
enum:
- InstallAndEnable
- NoAction
Expand Down
2 changes: 1 addition & 1 deletion config/v1/zz_generated.swagger_doc_generated.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion openapi/generated_openapi/zz_generated.openapi.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 3 additions & 0 deletions payload-manifests/crds/0000_10_config-operator_01_networks-CustomNoUpgrade.crd.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -273,6 +273,9 @@ spec:
Valid values are "InstallAndEnable" and "NoAction".
When set to "InstallAndEnable", ensure that network observability will be installed and enabled on the cluster. If already installed, no action taken, but if it gets uninstalled, it will install it again.
When set to "NoAction", nothing will be done regarding Network observability.
During the installation of NetworkObservability, the platform checks for any existing manual installations.
If a successful installation using the OLMv0 or OLMv1 API is detected, it will be used.
If the platform cannot determine how the current version was installed, or if the existing installation is incomplete, the installation process will stop.
enum:
- InstallAndEnable
- NoAction
Expand Down
3 changes: 3 additions & 0 deletions payload-manifests/crds/0000_10_config-operator_01_networks-DevPreviewNoUpgrade.crd.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -273,6 +273,9 @@ spec:
Valid values are "InstallAndEnable" and "NoAction".
When set to "InstallAndEnable", ensure that network observability will be installed and enabled on the cluster. If already installed, no action taken, but if it gets uninstalled, it will install it again.
When set to "NoAction", nothing will be done regarding Network observability.
During the installation of NetworkObservability, the platform checks for any existing manual installations.
If a successful installation using the OLMv0 or OLMv1 API is detected, it will be used.
If the platform cannot determine how the current version was installed, or if the existing installation is incomplete, the installation process will stop.
enum:
- InstallAndEnable
- NoAction
Expand Down
3 changes: 3 additions & 0 deletions payload-manifests/crds/0000_10_config-operator_01_networks-TechPreviewNoUpgrade.crd.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -273,6 +273,9 @@ spec:
Valid values are "InstallAndEnable" and "NoAction".
When set to "InstallAndEnable", ensure that network observability will be installed and enabled on the cluster. If already installed, no action taken, but if it gets uninstalled, it will install it again.
When set to "NoAction", nothing will be done regarding Network observability.
During the installation of NetworkObservability, the platform checks for any existing manual installations.
If a successful installation using the OLMv0 or OLMv1 API is detected, it will be used.
If the platform cannot determine how the current version was installed, or if the existing installation is incomplete, the installation process will stop.
enum:
- InstallAndEnable
- NoAction
Expand Down