diff --git a/cli/command-reference/roxctl-declarative-config.adoc b/cli/command-reference/roxctl-declarative-config.adoc index cd421b41c3e6..5e04fbfd2739 100644 --- a/cli/command-reference/roxctl-declarative-config.adoc +++ b/cli/command-reference/roxctl-declarative-config.adoc @@ -6,25 +6,15 @@ include::modules/common-attributes.adoc[] toc::[] -Manage the declarative configuration. +[role="_abstract"] +Use the `roxctl declarative-config` command to manage declarative configurations. This reference covers the command syntax, available subcommands, and configuration options. -.Usage -[source,terminal] ----- -$ roxctl declarative-config [command] [flags] ----- +//roxctl declarative-config overview +include::modules/roxctl-declarative-config-overview.adoc[leveloffset=+1] -.Available commands -[cols="2,2",options="header"] -|=== -|Command |Description +include::modules/roxctl-declarative-config-usage.adoc[leveloffset=+2] -|`create` -|Create declarative configurations. - -|`lint` -| Lint an existing declarative configuration YAML file. -|=== +include::modules/roxctl-declarative-config-available-commands.adoc[leveloffset=+2] //Options inherited from the parent command :commandname: roxctl declarative-config @@ -34,29 +24,85 @@ include::modules/options-inherited-from-the-parent-command.adoc[leveloffset=+1] //roxctl declarative-config lint include::modules/roxctl-declarative-config-lint.adoc[leveloffset=+1] +include::modules/roxctl-declarative-config-lint-usage.adoc[leveloffset=+2] + +include::modules/roxctl-declarative-config-lint-options.adoc[leveloffset=+2] + //roxctl declarative-config create include::modules/roxctl-declarative-config-create.adoc[leveloffset=+1] +include::modules/roxctl-declarative-config-create-usage.adoc[leveloffset=+2] + +include::modules/roxctl-declarative-config-create-options.adoc[leveloffset=+2] + include::modules/roxctl-declarative-config-create-role.adoc[leveloffset=+2] +include::modules/roxctl-declarative-config-create-role-usage.adoc[leveloffset=+3] + +include::modules/roxctl-declarative-config-create-role-options.adoc[leveloffset=+3] + include::modules/roxctl-declarative-config-create-notifier.adoc[leveloffset=+2] +include::modules/roxctl-declarative-config-create-notifier-usage.adoc[leveloffset=+3] + +include::modules/roxctl-declarative-config-create-notifier-options.adoc[leveloffset=+3] + include::modules/roxctl-declarative-config-create-access-scope.adoc[leveloffset=+2] +include::modules/roxctl-declarative-config-create-access-scope-usage.adoc[leveloffset=+3] + +include::modules/roxctl-declarative-config-create-access-scope-options.adoc[leveloffset=+3] + include::modules/roxctl-declarative-config-create-auth-provider.adoc[leveloffset=+2] +include::modules/roxctl-declarative-config-create-auth-provider-usage.adoc[leveloffset=+3] + +include::modules/roxctl-declarative-config-create-auth-provider-options.adoc[leveloffset=+3] + include::modules/roxctl-declarative-config-create-permission-set.adoc[leveloffset=+2] +include::modules/roxctl-declarative-config-create-permission-set-usage.adoc[leveloffset=+3] + +include::modules/roxctl-declarative-config-create-permission-set-options.adoc[leveloffset=+3] + include::modules/roxctl-declarative-config-create-notifier-splunk.adoc[leveloffset=+2] +include::modules/roxctl-declarative-config-create-notifier-splunk-usage.adoc[leveloffset=+3] + +include::modules/roxctl-declarative-config-create-notifier-splunk-options.adoc[leveloffset=+3] + include::modules/roxctl-declarative-config-create-notifier-generic.adoc[leveloffset=+2] +include::modules/roxctl-declarative-config-create-notifier-generic-usage.adoc[leveloffset=+3] + +include::modules/roxctl-declarative-config-create-notifier-generic-options.adoc[leveloffset=+3] + include::modules/roxctl-declarative-config-create-auth-provider-iap.adoc[leveloffset=+2] +include::modules/roxctl-declarative-config-create-auth-provider-iap-usage.adoc[leveloffset=+3] + +include::modules/roxctl-declarative-config-create-auth-provider-iap-options.adoc[leveloffset=+3] + include::modules/roxctl-declarative-config-create-auth-provider-oidc.adoc[leveloffset=+2] +include::modules/roxctl-declarative-config-create-auth-provider-oidc-usage.adoc[leveloffset=+3] + +include::modules/roxctl-declarative-config-create-auth-provider-oidc-options.adoc[leveloffset=+3] + include::modules/roxctl-declarative-config-create-auth-provider-saml.adoc[leveloffset=+2] +include::modules/roxctl-declarative-config-create-auth-provider-saml-usage.adoc[leveloffset=+3] + +include::modules/roxctl-declarative-config-create-auth-provider-saml-options.adoc[leveloffset=+3] + include::modules/roxctl-declarative-config-create-auth-provider-userpki.adoc[leveloffset=+2] -include::modules/roxctl-declarative-config-create-auth-provider-openshift-auth.adoc[leveloffset=+2] \ No newline at end of file +include::modules/roxctl-declarative-config-create-auth-provider-userpki-usage.adoc[leveloffset=+3] + +include::modules/roxctl-declarative-config-create-auth-provider-userpki-options.adoc[leveloffset=+3] + +include::modules/roxctl-declarative-config-create-auth-provider-openshift-auth.adoc[leveloffset=+2] + +include::modules/roxctl-declarative-config-create-auth-provider-openshift-auth-usage.adoc[leveloffset=+3] + +include::modules/roxctl-declarative-config-create-auth-provider-openshift-auth-options.adoc[leveloffset=+3] diff --git a/modules/options-inherited-from-the-parent-command.adoc b/modules/options-inherited-from-the-parent-command.adoc index ac52a7e2a577..e5e452728053 100644 --- a/modules/options-inherited-from-the-parent-command.adoc +++ b/modules/options-inherited-from-the-parent-command.adoc @@ -25,43 +25,44 @@ endif::[] [id="options-inherited-from-the-parent-command_{context}"] = {commandname} command options inherited from the parent command +[role="_abstract"] The `{commandname}` command supports the following options inherited from the parent `roxctl` command: [cols="2,2",options="header"] |=== |Option |Description -|`--ca string` +|`--ca string` |Specify a custom CA certificate file path for secure connections. Alternatively, you can specify the file path by using the `ROX_CA_CERT_FILE` environment variable. -|`--direct-grpc` +|`--direct-grpc` |Set `--direct-grpc` for improved connection performance. Alternatively, by setting the `ROX_DIRECT_GRPC_CLIENT` environment variable to `true`, you can enable direct gRPC . The default value is `false`. -|`-e`, `--endpoint string` +|`-e`, `--endpoint string` |Set the endpoint for the service to contact. Alternatively, you can set the endpoint by using the `ROX_ENDPOINT` environment variable. The default value is `localhost:8443`. -|`--force-http1` +|`--force-http1` |Force the use of HTTP/1 for all connections. Alternatively, by setting the `ROX_CLIENT_FORCE_HTTP1` environment variable to `true`, you can force the use of HTTP/1. The default value is `false`. -|`--insecure` +|`--insecure` |Enable insecure connection options. Alternatively, by setting the `ROX_INSECURE_CLIENT` environment variable to `true`, you can enable insecure connection options. The default value is `false`. -|`--insecure-skip-tls-verify` +|`--insecure-skip-tls-verify` a|Skip the TLS certificate validation. Alternatively, by setting the `ROX_INSECURE_CLIENT_SKIP_TLS_VERIFY` environment variable to `true`, you can skip the TLS certificate validation. The default value is `false`. -|`--no-color` +|`--no-color` |Disable the color output. Alternatively, by setting the `ROX_NO_COLOR environment variable` to `true`, you can disable the color output. The default value is `false`. -|`-p`, `--password string` +|`-p`, `--password string` |Specify the password for basic authentication. Alternatively, you can set the password by using the `ROX_ADMIN_PASSWORD` environment variable. -|`--plaintext` +|`--plaintext` |Use an unencrypted connection. Alternatively, by setting the `ROX_PLAINTEXT` environment variable to `true`, you can enable an unencrypted connection. The default value is `false`. -|`-s`, `--server-name string` +|`-s`, `--server-name string` |Set the TLS server name to use for SNI. Alternatively, you can set the server name by using the `ROX_SERVER_NAME` environment variable. -|`--token-file string` +|`--token-file string` |Use the API token provided in the specified file for authentication. Alternatively, you can set the token by using the `ROX_API_TOKEN` environment variable. |=== diff --git a/modules/roxctl-declarative-config-available-commands.adoc b/modules/roxctl-declarative-config-available-commands.adoc new file mode 100644 index 000000000000..712c7b6e3517 --- /dev/null +++ b/modules/roxctl-declarative-config-available-commands.adoc @@ -0,0 +1,21 @@ +// Module included in the following assemblies: +// +// * command-reference/roxctl-declarative-config.adoc + +:_mod-docs-content-type: REFERENCE +[id="roxctl-declarative-config-available-commands_{context}"] += Available commands + +[role="_abstract"] +Available commands for the `roxctl declarative-config` command. + +[cols="2,2",options="header"] +|=== +|Command |Description + +|`create` +|Create declarative configurations. + +|`lint` +| Lint an existing declarative configuration YAML file. +|=== diff --git a/modules/roxctl-declarative-config-create-access-scope-options.adoc b/modules/roxctl-declarative-config-create-access-scope-options.adoc new file mode 100644 index 000000000000..4e6f13420a23 --- /dev/null +++ b/modules/roxctl-declarative-config-create-access-scope-options.adoc @@ -0,0 +1,30 @@ +// Module included in the following assemblies: +// +// * command-reference/roxctl-declarative-config.adoc + +:_mod-docs-content-type: REFERENCE +[id="roxctl-declarative-config-create-access-scope-options_{context}"] += Options + +[role="_abstract"] +Options for the `roxctl declarative-config create access-scope` command. + +[cols="6,3",options="header"] +|=== +|Option |Description + +|`--cluster-label-selector requirement` +|Specify the criteria for creating a label selector based on the cluster's labels. The key-value pairs represent requirements, and you can use this flag many times to create a combination of requirements. The default value is `[ [ ] ]`. For more details, run the `roxctl declarative-config create access-scope --help` command. + +|`--description string` +|Set a description for the access scope. + +|`--included included-object` +|Specify a list of clusters and their namespaces that you want to include in the access scope. The default value is `[null]`. + +|`--name string` +|Specify the name of the access scope. + +|`--namespace-label-selector requirement` +|Specify the criteria for creating a label selector based on the namespace's labels. Similar to the cluster-label-selector, you can use this flag many times for the combination of requirements. For more details, run the `roxctl declarative-config create access-scope --help` command. +|=== diff --git a/modules/roxctl-declarative-config-create-access-scope-usage.adoc b/modules/roxctl-declarative-config-create-access-scope-usage.adoc new file mode 100644 index 000000000000..d3fb938a21f6 --- /dev/null +++ b/modules/roxctl-declarative-config-create-access-scope-usage.adoc @@ -0,0 +1,16 @@ +// Module included in the following assemblies: +// +// * command-reference/roxctl-declarative-config.adoc + +:_mod-docs-content-type: REFERENCE +[id="roxctl-declarative-config-create-access-scope-usage_{context}"] += roxctl declarative-config create access-scope usage + +[role="_abstract"] +Usage syntax for the `roxctl declarative-config create access-scope` command. + +.Usage +[source,terminal] +---- +$ roxctl declarative-config create access-scope [flags] +---- diff --git a/modules/roxctl-declarative-config-create-access-scope.adoc b/modules/roxctl-declarative-config-create-access-scope.adoc index 668e31121bae..5c08e712e3d4 100644 --- a/modules/roxctl-declarative-config-create-access-scope.adoc +++ b/modules/roxctl-declarative-config-create-access-scope.adoc @@ -2,35 +2,9 @@ // // * command-reference/roxctl-declarative-config.adoc -:_mod-docs-content-type: REFERENCE +:_mod-docs-content-type: CONCEPT [id="roxctl-declarative-config-create-access-scope_{context}"] = roxctl declarative-config create access-scope +[role="_abstract"] Create a declarative configuration for an access scope. - -.Usage -[source,terminal] ----- -$ roxctl declarative-config create access-scope [flags] ----- - -.Options -[cols="6,3",options="header"] -|=== -|Option |Description - -|`--cluster-label-selector requirement` -|Specify the criteria for creating a label selector based on the cluster's labels. The key-value pairs represent requirements, and you can use this flag multiple times to create a combination of requirements. The default value is `[ [ ] ]`. For more details, run the `roxctl declarative-config create access-scope --help` command. - -|`--description string` -|Set a description for the access scope. - -|`--included included-object` -|Specify a list of clusters and their namespaces that you want to include in the access scope. The default value is `[null]`. - -|`--name string` -|Specify the name of the access scope. - -|`--namespace-label-selector requirement` -|Specify the criteria for creating a label selector based on the namespace's labels. Similar to the cluster-label-selector, you can use this flag multiple times for the combination of requirements. For more details, run the `roxctl declarative-config create access-scope --help` command. -|=== \ No newline at end of file diff --git a/modules/roxctl-declarative-config-create-auth-provider-iap-options.adoc b/modules/roxctl-declarative-config-create-auth-provider-iap-options.adoc new file mode 100644 index 000000000000..61e6ede889ca --- /dev/null +++ b/modules/roxctl-declarative-config-create-auth-provider-iap-options.adoc @@ -0,0 +1,18 @@ +// Module included in the following assemblies: +// +// * command-reference/roxctl-declarative-config.adoc + +:_mod-docs-content-type: REFERENCE +[id="roxctl-declarative-config-create-auth-provider-iap-options_{context}"] += Options + +[role="_abstract"] +Options for the `roxctl declarative-config create auth-provider iap` command. + +[cols="2,2",options="header"] +|=== +|Option |Description + +|`--audience string` +|Specify the target group that you want to validate. +|=== diff --git a/modules/roxctl-declarative-config-create-auth-provider-iap-usage.adoc b/modules/roxctl-declarative-config-create-auth-provider-iap-usage.adoc new file mode 100644 index 000000000000..783124cc54a8 --- /dev/null +++ b/modules/roxctl-declarative-config-create-auth-provider-iap-usage.adoc @@ -0,0 +1,16 @@ +// Module included in the following assemblies: +// +// * command-reference/roxctl-declarative-config.adoc + +:_mod-docs-content-type: REFERENCE +[id="roxctl-declarative-config-create-auth-provider-iap-usage_{context}"] += roxctl declarative-config create auth-provider iap usage + +[role="_abstract"] +Usage syntax for the `roxctl declarative-config create auth-provider iap` command. + +.Usage +[source,terminal] +---- +$ roxctl declarative-config create auth-provider iap [flags] +---- diff --git a/modules/roxctl-declarative-config-create-auth-provider-iap.adoc b/modules/roxctl-declarative-config-create-auth-provider-iap.adoc index 6f38e7ba073e..4a229d447983 100644 --- a/modules/roxctl-declarative-config-create-auth-provider-iap.adoc +++ b/modules/roxctl-declarative-config-create-auth-provider-iap.adoc @@ -2,23 +2,9 @@ // // * command-reference/roxctl-declarative-config.adoc -:_mod-docs-content-type: REFERENCE +:_mod-docs-content-type: CONCEPT [id="roxctl-declarative-config-create-auth-provider-iap_{context}"] = roxctl declarative-config create auth-provider iap -Create a declarative configuration for an authentication provider with the identity-aware proxy (IAP) identifier. - -.Usage -[source,terminal] ----- -$ roxctl declarative-config create auth-provider iap [flags] ----- - -.Options -[cols="2,2",options="header"] -|=== -|Option |Description - -|`--audience string` -|Specify the target group that you want to validate. -|=== \ No newline at end of file +[role="_abstract"] +Create a declarative configuration for an authentication provider with the identity-aware proxy (IAP) identifier. diff --git a/modules/roxctl-declarative-config-create-auth-provider-oidc-options.adoc b/modules/roxctl-declarative-config-create-auth-provider-oidc-options.adoc new file mode 100644 index 000000000000..e5d852abb6e1 --- /dev/null +++ b/modules/roxctl-declarative-config-create-auth-provider-oidc-options.adoc @@ -0,0 +1,33 @@ +// Module included in the following assemblies: +// +// * command-reference/roxctl-declarative-config.adoc + +:_mod-docs-content-type: REFERENCE +[id="roxctl-declarative-config-create-auth-provider-oidc-options_{context}"] += Options + +[role="_abstract"] +Options for the `roxctl declarative-config create auth-provider oidc` command. + +[cols="6,3",options="header"] +|=== +|Option |Description + +|`--claim-mappings stringToString` +|Specify a list of non-standard claims from the identity provider (IdP) token that you want to include in the authentication provider's rules. The default value is `[]`. + +|`--client-id string` +|Specify the client ID of the OIDC client. + +|`--client-secret string` +|Specify the client secret of the OIDC client. + +|`--disable-offline-access` +|Disable the request for the offline_access from the OIDC IdP. You need to use this option if the OIDC IdP limits the number of sessions with the `offline_access` scope. The default value is `false`. + +|`--issuer string` +|Specify the issuer of the OIDC client. + +|`--mode string` +|Specify the callback mode that you want to use. Valid values include `auto`, `post`, `query` and `fragment`. The default value is `auto`. +|=== diff --git a/modules/roxctl-declarative-config-create-auth-provider-oidc-usage.adoc b/modules/roxctl-declarative-config-create-auth-provider-oidc-usage.adoc new file mode 100644 index 000000000000..9f649b27c0fd --- /dev/null +++ b/modules/roxctl-declarative-config-create-auth-provider-oidc-usage.adoc @@ -0,0 +1,16 @@ +// Module included in the following assemblies: +// +// * command-reference/roxctl-declarative-config.adoc + +:_mod-docs-content-type: REFERENCE +[id="roxctl-declarative-config-create-auth-provider-oidc-usage_{context}"] += roxctl declarative-config create auth-provider oidc usage + +[role="_abstract"] +Usage syntax for the `roxctl declarative-config create auth-provider oidc` command. + +.Usage +[source,terminal] +---- +$ roxctl declarative-config create auth-provider oidc [flags] +---- diff --git a/modules/roxctl-declarative-config-create-auth-provider-oidc.adoc b/modules/roxctl-declarative-config-create-auth-provider-oidc.adoc index 511fba5bc6e5..c117709906e3 100644 --- a/modules/roxctl-declarative-config-create-auth-provider-oidc.adoc +++ b/modules/roxctl-declarative-config-create-auth-provider-oidc.adoc @@ -2,38 +2,9 @@ // // * command-reference/roxctl-declarative-config.adoc -:_mod-docs-content-type: REFERENCE +:_mod-docs-content-type: CONCEPT [id="roxctl-declarative-config-create-auth-provider-oidc_{context}"] = roxctl declarative-config create auth-provider oidc +[role="_abstract"] Create a declarative configuration for an OpenID Connect (OIDC) authentication provider. - -.Usage -[source,terminal] ----- -$ roxctl declarative-config create auth-provider oidc [flags] ----- - -.Options -[cols="6,3",options="header"] -|=== -|Option |Description - -|`--claim-mappings stringToString` -|Specify a list of non-standard claims from the identity provider (IdP) token that you want to include in the authentication provider's rules. The default value is `[]`. - -|`--client-id string` -|Specify the client ID of the OIDC client. - -|`--client-secret string` -|Specify the client secret of the OIDC client. - -|`--disable-offline-access` -|Disable the request for the offline_access from the OIDC IdP. You need to use this option if the OIDC IdP limits the number of sessions with the `offline_access` scope. The default value is `false`. - -|`--issuer string` -|Specify the issuer of the OIDC client. - -|`--mode string` -|Specify the callback mode that you want to use. Valid values include `auto`, `post`, `query` and `fragment`. The default value is `auto`. -|=== \ No newline at end of file diff --git a/modules/roxctl-declarative-config-create-auth-provider-openshift-auth-options.adoc b/modules/roxctl-declarative-config-create-auth-provider-openshift-auth-options.adoc new file mode 100644 index 000000000000..fb952f269daa --- /dev/null +++ b/modules/roxctl-declarative-config-create-auth-provider-openshift-auth-options.adoc @@ -0,0 +1,10 @@ +// Module included in the following assemblies: +// +// * command-reference/roxctl-declarative-config.adoc + +:_mod-docs-content-type: REFERENCE +[id="roxctl-declarative-config-create-auth-provider-openshift-auth-options_{context}"] += Options + +[role="_abstract"] +This command has no options. diff --git a/modules/roxctl-declarative-config-create-auth-provider-openshift-auth-usage.adoc b/modules/roxctl-declarative-config-create-auth-provider-openshift-auth-usage.adoc new file mode 100644 index 000000000000..689974b77907 --- /dev/null +++ b/modules/roxctl-declarative-config-create-auth-provider-openshift-auth-usage.adoc @@ -0,0 +1,16 @@ +// Module included in the following assemblies: +// +// * command-reference/roxctl-declarative-config.adoc + +:_mod-docs-content-type: REFERENCE +[id="roxctl-declarative-config-create-auth-provider-openshift-auth-usage_{context}"] += roxctl declarative-config create auth-provider openshift-auth usage + +[role="_abstract"] +Usage syntax for the `roxctl declarative-config create auth-provider openshift-auth` command. + +.Usage +[source,terminal] +---- +$ roxctl declarative-config create auth-provider openshift-auth [flags] +---- diff --git a/modules/roxctl-declarative-config-create-auth-provider-openshift-auth.adoc b/modules/roxctl-declarative-config-create-auth-provider-openshift-auth.adoc index 41a35653719b..ce3415485f00 100644 --- a/modules/roxctl-declarative-config-create-auth-provider-openshift-auth.adoc +++ b/modules/roxctl-declarative-config-create-auth-provider-openshift-auth.adoc @@ -2,14 +2,9 @@ // // * command-reference/roxctl-declarative-config.adoc -:_mod-docs-content-type: REFERENCE +:_mod-docs-content-type: CONCEPT [id="roxctl-declarative-config-create-auth-provider-openshift-auth_{context}"] = roxctl declarative-config create auth-provider openshift-auth +[role="_abstract"] Create a declarative configuration for an {ocp} OAuth authentication provider. - -.Usage -[source,terminal] ----- -$ roxctl declarative-config create auth-provider openshift-auth [flags] ----- \ No newline at end of file diff --git a/modules/roxctl-declarative-config-create-auth-provider-options.adoc b/modules/roxctl-declarative-config-create-auth-provider-options.adoc new file mode 100644 index 000000000000..e2b4e3f3e95f --- /dev/null +++ b/modules/roxctl-declarative-config-create-auth-provider-options.adoc @@ -0,0 +1,39 @@ +// Module included in the following assemblies: +// +// * command-reference/roxctl-declarative-config.adoc + +:_mod-docs-content-type: REFERENCE +[id="roxctl-declarative-config-create-auth-provider-options_{context}"] += Options + +[role="_abstract"] +Options for the `roxctl declarative-config create auth-provider` command. + +[cols="6,3",options="header"] +|=== +|Option |Description + +|`--extra-ui-endpoints strings` +|Specify additional user interface (UI) endpoints where you use the authentication provider. The expected format is `:`. + +|`--groups-key strings` +|Set the keys of the groups that you want to add within the authentication provider. The tuples of key, value and role should have the same length. For more details, run the `roxctl declarative-config create auth-provider --help` command. + +|`--groups-role strings` +|Set the role of the groups that you want to add within the authentication provider. The tuples of key, value and role should have the same length. For more details, run the `roxctl declarative-config create auth-provider --help` command. + +|`--groups-value strings` +|Set the values of the groups that you want to add within the authentication provider. The tuples of key, value and role should have the same length. For more details, run the `roxctl declarative-config create auth-provider --help` command. + +|`--minimum-access-role string` +|Set the minimum access role of the authentication provider. You can leave this field empty if you do not want to configure the minimum access role by using the declarative configuration. + +|`--name string` +|Specify the name of the authentication provider. + +|`--required-attributes stringToString` +|Set a list of attributes that the authentication provider must return during authentication. The default value is `[]`. + +|`--ui-endpoint string` +|Set the UI endpoint where you use the authentication provider. This is usually the public endpoint where {product-title-short} is available. The expected format is `:`. +|=== diff --git a/modules/roxctl-declarative-config-create-auth-provider-saml-options.adoc b/modules/roxctl-declarative-config-create-auth-provider-saml-options.adoc new file mode 100644 index 000000000000..5c06dc886ec1 --- /dev/null +++ b/modules/roxctl-declarative-config-create-auth-provider-saml-options.adoc @@ -0,0 +1,33 @@ +// Module included in the following assemblies: +// +// * command-reference/roxctl-declarative-config.adoc + +:_mod-docs-content-type: REFERENCE +[id="roxctl-declarative-config-create-auth-provider-saml-options_{context}"] += Options + +[role="_abstract"] +Options for the `roxctl declarative-config create auth-provider saml` command. + +[cols="2,2",options="header"] +|=== +|Option |Description + +|`--idp-cert string` +|Specify the file containing the SAML identity provider (IdP) certificate in PEM format. + +|`--idp-issuer string` +|Specify the issuer of the IdP. + +|`--metadata-url string` +|Specify the metadata URL of the service provider. + +|`--name-id-format string` +|Specify the format of the name ID. + +|`--sp-issuer string` +|Specify the issuer of the service provider. + +|`--sso-url string` +|Specify the URL of the IdP for single sign-on (SSO). +|=== diff --git a/modules/roxctl-declarative-config-create-auth-provider-saml-usage.adoc b/modules/roxctl-declarative-config-create-auth-provider-saml-usage.adoc new file mode 100644 index 000000000000..fe0a4e8a9306 --- /dev/null +++ b/modules/roxctl-declarative-config-create-auth-provider-saml-usage.adoc @@ -0,0 +1,16 @@ +// Module included in the following assemblies: +// +// * command-reference/roxctl-declarative-config.adoc + +:_mod-docs-content-type: REFERENCE +[id="roxctl-declarative-config-create-auth-provider-saml-usage_{context}"] += roxctl declarative-config create auth-provider saml usage + +[role="_abstract"] +Usage syntax for the `roxctl declarative-config create auth-provider saml` command. + +.Usage +[source,terminal] +---- +$ roxctl declarative-config create auth-provider saml [flags] +---- diff --git a/modules/roxctl-declarative-config-create-auth-provider-saml.adoc b/modules/roxctl-declarative-config-create-auth-provider-saml.adoc index 7f0bbf1cb239..8898ee5ad3e2 100644 --- a/modules/roxctl-declarative-config-create-auth-provider-saml.adoc +++ b/modules/roxctl-declarative-config-create-auth-provider-saml.adoc @@ -2,38 +2,9 @@ // // * command-reference/roxctl-declarative-config.adoc -:_mod-docs-content-type: REFERENCE +:_mod-docs-content-type: CONCEPT [id="roxctl-declarative-config-create-auth-provider-saml_{context}"] = roxctl declarative-config create auth-provider saml +[role="_abstract"] Create a declarative configuration for a SAML authentication provider. - -.Usage -[source,terminal] ----- -$ roxctl declarative-config create auth-provider saml [flags] ----- - -.Options -[cols="2,2",options="header"] -|=== -|Option |Description - -|`--idp-cert string` -|Specify the file containing the SAML identity provider (IdP) certificate in PEM format. - -|`--idp-issuer string` -|Specify the issuer of the IdP. - -|`--metadata-url string` -|Specify the metadata URL of the service provider. - -|`--name-id-format string` -|Specify the format of the name ID. - -|`--sp-issuer string` -|Specify the issuer of the service provider. - -|`--sso-url string` -|Specify the URL of the IdP for single sign-on (SSO). -|=== \ No newline at end of file diff --git a/modules/roxctl-declarative-config-create-auth-provider-usage.adoc b/modules/roxctl-declarative-config-create-auth-provider-usage.adoc new file mode 100644 index 000000000000..bfb5745f9253 --- /dev/null +++ b/modules/roxctl-declarative-config-create-auth-provider-usage.adoc @@ -0,0 +1,16 @@ +// Module included in the following assemblies: +// +// * command-reference/roxctl-declarative-config.adoc + +:_mod-docs-content-type: REFERENCE +[id="roxctl-declarative-config-create-auth-provider-usage_{context}"] += roxctl declarative-config create auth-provider usage + +[role="_abstract"] +Usage syntax for the `roxctl declarative-config create auth-provider` command. + +.Usage +[source,terminal] +---- +$ roxctl declarative-config create auth-provider [flags] +---- diff --git a/modules/roxctl-declarative-config-create-auth-provider-userpki-options.adoc b/modules/roxctl-declarative-config-create-auth-provider-userpki-options.adoc new file mode 100644 index 000000000000..2ab8e7d909f3 --- /dev/null +++ b/modules/roxctl-declarative-config-create-auth-provider-userpki-options.adoc @@ -0,0 +1,18 @@ +// Module included in the following assemblies: +// +// * command-reference/roxctl-declarative-config.adoc + +:_mod-docs-content-type: REFERENCE +[id="roxctl-declarative-config-create-auth-provider-userpki-options_{context}"] += Options + +[role="_abstract"] +Options for the `roxctl declarative-config create auth-provider userpki` command. + +[cols="2,2",options="header"] +|=== +|Option |Description + +|`--ca-file string` +|Specify the file containing the certification authorities in PEM format. +|=== diff --git a/modules/roxctl-declarative-config-create-auth-provider-userpki-usage.adoc b/modules/roxctl-declarative-config-create-auth-provider-userpki-usage.adoc new file mode 100644 index 000000000000..adcd8288c731 --- /dev/null +++ b/modules/roxctl-declarative-config-create-auth-provider-userpki-usage.adoc @@ -0,0 +1,16 @@ +// Module included in the following assemblies: +// +// * command-reference/roxctl-declarative-config.adoc + +:_mod-docs-content-type: REFERENCE +[id="roxctl-declarative-config-create-auth-provider-userpki-usage_{context}"] += roxctl declarative-config create auth-provider userpki usage + +[role="_abstract"] +Usage syntax for the `roxctl declarative-config create auth-provider userpki` command. + +.Usage +[source,terminal] +---- +$ roxctl declarative-config create auth-provider userpki [flags] +---- diff --git a/modules/roxctl-declarative-config-create-auth-provider-userpki.adoc b/modules/roxctl-declarative-config-create-auth-provider-userpki.adoc index ae7637d4db91..1f5b182ff08b 100644 --- a/modules/roxctl-declarative-config-create-auth-provider-userpki.adoc +++ b/modules/roxctl-declarative-config-create-auth-provider-userpki.adoc @@ -2,23 +2,9 @@ // // * command-reference/roxctl-declarative-config.adoc -:_mod-docs-content-type: REFERENCE +:_mod-docs-content-type: CONCEPT [id="roxctl-declarative-config-create-auth-provider-userpki_{context}"] = roxctl declarative-config create auth-provider userpki +[role="_abstract"] Create a declarative configuration for an user PKI authentication provider. - -.Usage -[source,terminal] ----- -$ roxctl declarative-config create auth-provider userpki [flags] ----- - -.Options -[cols="2,2",options="header"] -|=== -|Option |Description - -|`--ca-file string` -|Specify the file containing the certification authorities in PEM format. -|=== \ No newline at end of file diff --git a/modules/roxctl-declarative-config-create-auth-provider.adoc b/modules/roxctl-declarative-config-create-auth-provider.adoc index 4ae1ff0288f4..0204c3bb87a0 100644 --- a/modules/roxctl-declarative-config-create-auth-provider.adoc +++ b/modules/roxctl-declarative-config-create-auth-provider.adoc @@ -2,44 +2,9 @@ // // * command-reference/roxctl-declarative-config.adoc -:_mod-docs-content-type: REFERENCE +:_mod-docs-content-type: CONCEPT [id="roxctl-declarative-config-create-auth-provider_{context}"] = roxctl declarative-config create auth-provider +[role="_abstract"] Create a declarative configuration for an authentication provider. - -.Usage -[source,terminal] ----- -$ roxctl declarative-config create auth-provider [flags] ----- - -.Options -[cols="6,3",options="header"] -|=== -|Option |Description - -|`--extra-ui-endpoints strings` -|Specify additional user interface (UI) endpoints from which the authentication provider is used. The expected format is `:`. - -|`--groups-key strings` -|Set the keys of the groups that you want to add within the authentication provider. The tuples of key, value and role should have the same length. For more details, run the `roxctl declarative-config create auth-provider --help` command. - -|`--groups-role strings` -|Set the role of the groups that you want to add within the authentication provider. The tuples of key, value and role should have the same length. For more details, run the `roxctl declarative-config create auth-provider --help` command. - -|`--groups-value strings` -|Set the values of the groups that you want to add within the authentication provider. The tuples of key, value and role should have the same length. For more details, run the `roxctl declarative-config create auth-provider --help` command. - -|`--minimum-access-role string` -|Set the minimum access role of the authentication provider. You can leave this field empty if you do not want to configure the minimum access role by using the declarative configuration. - -|`--name string` -|Specify the name of the authentication provider. - -|`--required-attributes stringToString` -|Set a list of attributes that the authentication provider must return during authentication. The default value is `[]`. - -|`--ui-endpoint string` -|Set the UI endpoint from which the authentication provider is used. This is usually the public endpoint where {product-title-short} is available. The expected format is `:`. -|=== \ No newline at end of file diff --git a/modules/roxctl-declarative-config-create-notifier-generic-options.adoc b/modules/roxctl-declarative-config-create-notifier-generic-options.adoc new file mode 100644 index 000000000000..885f8cdba4cc --- /dev/null +++ b/modules/roxctl-declarative-config-create-notifier-generic-options.adoc @@ -0,0 +1,39 @@ +// Module included in the following assemblies: +// +// * command-reference/roxctl-declarative-config.adoc + +:_mod-docs-content-type: REFERENCE +[id="roxctl-declarative-config-create-notifier-generic-options_{context}"] += Options + +[role="_abstract"] +Options for the `roxctl declarative-config create notifier generic` command. + +[cols="2,2",options="header"] +|=== +|Option |Description + +|`--audit-logging` +|Enable audit logging. The default value is `false`. + +|`--extra-fields stringToString` +|Specify additional fields as comma-separated `key=value` pairs. The default value is `[]`. + +|`--headers stringToString` +|Specify headers as comma-separated `key=value` pairs. The default value is `[]`. + +|`--webhook-cacert-file string` +|Specify the file name of the endpoint CA certificate in PEM format. + +|`--webhook-endpoint string` +|Specify the URL of the webhook endpoint. + +|`--webhook-password string` +|Specify the password for Basic HTTP authentication of the webhook endpoint. No authentication if not specified. Requires `--webhook-username`. + +|`--webhook-skip-tls-verify` +|Skip webhook TLS verification. The default value is `false`. + +|`--webhook-username string` +|Specify the username for Basic HTTP authentication of the webhook endpoint. No authentication occurs if not specified. Requires `--webhook-password`. +|=== diff --git a/modules/roxctl-declarative-config-create-notifier-generic-usage.adoc b/modules/roxctl-declarative-config-create-notifier-generic-usage.adoc new file mode 100644 index 000000000000..5f1634f03027 --- /dev/null +++ b/modules/roxctl-declarative-config-create-notifier-generic-usage.adoc @@ -0,0 +1,16 @@ +// Module included in the following assemblies: +// +// * command-reference/roxctl-declarative-config.adoc + +:_mod-docs-content-type: REFERENCE +[id="roxctl-declarative-config-create-notifier-generic-usage_{context}"] += roxctl declarative-config create notifier generic usage + +[role="_abstract"] +Usage syntax for the `roxctl declarative-config create notifier generic` command. + +.Usage +[source,terminal] +---- +$ roxctl declarative-config create notifier generic [flags] +---- diff --git a/modules/roxctl-declarative-config-create-notifier-generic.adoc b/modules/roxctl-declarative-config-create-notifier-generic.adoc index 97a075b943e8..a9642bc642dc 100644 --- a/modules/roxctl-declarative-config-create-notifier-generic.adoc +++ b/modules/roxctl-declarative-config-create-notifier-generic.adoc @@ -2,44 +2,9 @@ // // * command-reference/roxctl-declarative-config.adoc -:_mod-docs-content-type: REFERENCE +:_mod-docs-content-type: CONCEPT [id="roxctl-declarative-config-create-notifier-generic_{context}"] = roxctl declarative-config create notifier generic +[role="_abstract"] Create a declarative configuration for a generic notifier. - -.Usage -[source,terminal] ----- -$ roxctl declarative-config create notifier generic [flags] ----- - -.Options -[cols="2,2",options="header"] -|=== -|Option |Description - -|`--audit-logging` -|Enable audit logging. The default value is `false`. - -|`--extra-fields stringToString` -|Specify additional fields as comma-separated `key=value` pairs. The default value is `[]`. - -|`--headers stringToString` -|Specify headers as comma-separated `key=value` pairs. The default value is `[]`. - -|`--webhook-cacert-file string` -|Specify the file name of the endpoint CA certificate in PEM format. - -|`--webhook-endpoint string` -|Specify the URL of the webhook endpoint. - -|`--webhook-password string` -|Specify the password for basic authentication of the webhook endpoint. No authentication if not specified. Requires `--webhook-username`. - -|`--webhook-skip-tls-verify` -|Skip webhook TLS verification. The default value is `false`. - -|`--webhook-username string` -|Specify the username for basic authentication of the webhook endpoint. No authentication occurs if not specified. Requires `--webhook-password`. -|=== \ No newline at end of file diff --git a/modules/roxctl-declarative-config-create-notifier-options.adoc b/modules/roxctl-declarative-config-create-notifier-options.adoc new file mode 100644 index 000000000000..6813352146bd --- /dev/null +++ b/modules/roxctl-declarative-config-create-notifier-options.adoc @@ -0,0 +1,18 @@ +// Module included in the following assemblies: +// +// * command-reference/roxctl-declarative-config.adoc + +:_mod-docs-content-type: REFERENCE +[id="roxctl-declarative-config-create-notifier-options_{context}"] += Options + +[role="_abstract"] +Options for the `roxctl declarative-config create notifier` command. + +[cols="2,2",options="header"] +|=== +|Option |Description + +|`--name string` +|Specify the name of the notifier. +|=== diff --git a/modules/roxctl-declarative-config-create-notifier-splunk-options.adoc b/modules/roxctl-declarative-config-create-notifier-splunk-options.adoc new file mode 100644 index 000000000000..04e8a4b3ddfa --- /dev/null +++ b/modules/roxctl-declarative-config-create-notifier-splunk-options.adoc @@ -0,0 +1,33 @@ +// Module included in the following assemblies: +// +// * command-reference/roxctl-declarative-config.adoc + +:_mod-docs-content-type: REFERENCE +[id="roxctl-declarative-config-create-notifier-splunk-options_{context}"] += Options + +[role="_abstract"] +Options for the `roxctl declarative-config create notifier splunk` command. + +[cols="2,2",options="header"] +|=== +|Option |Description + +|`--audit-logging` +|Enable audit logging. The default value is `false`. + +|`--source-types stringToString` +|Specify Splunk source types as comma-separated `key=value` pairs. The default value is `[]`. + +|`--splunk-endpoint string` +|Specify the Splunk HTTP endpoint. This is a mandatory option. + +|`--splunk-skip-tls-verify` +|Use an insecure connection to Splunk. The default value is `false`. + +|`--splunk-token string` +|Specify the Splunk HTTP token. This is a mandatory option. + +|`--truncate int` +|Specify the Splunk truncate limit. The default value is `10000`. +|=== diff --git a/modules/roxctl-declarative-config-create-notifier-splunk-usage.adoc b/modules/roxctl-declarative-config-create-notifier-splunk-usage.adoc new file mode 100644 index 000000000000..fd7c1adb02f0 --- /dev/null +++ b/modules/roxctl-declarative-config-create-notifier-splunk-usage.adoc @@ -0,0 +1,16 @@ +// Module included in the following assemblies: +// +// * command-reference/roxctl-declarative-config.adoc + +:_mod-docs-content-type: REFERENCE +[id="roxctl-declarative-config-create-notifier-splunk-usage_{context}"] += roxctl declarative-config create notifier splunk usage + +[role="_abstract"] +Usage syntax for the `roxctl declarative-config create notifier splunk` command. + +.Usage +[source,terminal] +---- +$ roxctl declarative-config create notifier splunk [flags] +---- diff --git a/modules/roxctl-declarative-config-create-notifier-splunk.adoc b/modules/roxctl-declarative-config-create-notifier-splunk.adoc index 722ae985f683..f284fbb254d2 100644 --- a/modules/roxctl-declarative-config-create-notifier-splunk.adoc +++ b/modules/roxctl-declarative-config-create-notifier-splunk.adoc @@ -2,38 +2,9 @@ // // * command-reference/roxctl-declarative-config.adoc -:_mod-docs-content-type: REFERENCE +:_mod-docs-content-type: CONCEPT [id="roxctl-declarative-config-create-notifier-splunk_{context}"] = roxctl declarative-config create notifier splunk +[role="_abstract"] Create a declarative configuration for a splunk notifier. - -.Usage -[source,terminal] ----- -$ roxctl declarative-config create notifier splunk [flags] ----- - -.Options -[cols="2,2",options="header"] -|=== -|Option |Description - -|`--audit-logging` -|Enable audit logging. The default value is `false`. - -|`--source-types stringToString` -|Specify Splunk source types as comma-separated `key=value` pairs. The default value is `[]`. - -|`--splunk-endpoint string` -|Specify the Splunk HTTP endpoint. This is a mandatory option. - -|`--splunk-skip-tls-verify` -|Use an insecure connection to Splunk. The default value is `false`. - -|`--splunk-token string` -|Specify the Splunk HTTP token. This is a mandatory option. - -|`--truncate int` -|Specify the Splunk truncate limit. The default value is `10000`. -|=== \ No newline at end of file diff --git a/modules/roxctl-declarative-config-create-notifier-usage.adoc b/modules/roxctl-declarative-config-create-notifier-usage.adoc new file mode 100644 index 000000000000..fb90b3b976e0 --- /dev/null +++ b/modules/roxctl-declarative-config-create-notifier-usage.adoc @@ -0,0 +1,16 @@ +// Module included in the following assemblies: +// +// * command-reference/roxctl-declarative-config.adoc + +:_mod-docs-content-type: REFERENCE +[id="roxctl-declarative-config-create-notifier-usage_{context}"] += roxctl declarative-config create notifier usage + +[role="_abstract"] +Usage syntax for the `roxctl declarative-config create notifier` command. + +.Usage +[source,terminal] +---- +$ roxctl declarative-config create notifier [flags] +---- diff --git a/modules/roxctl-declarative-config-create-notifier.adoc b/modules/roxctl-declarative-config-create-notifier.adoc index cabd5399523f..f8a982dede89 100644 --- a/modules/roxctl-declarative-config-create-notifier.adoc +++ b/modules/roxctl-declarative-config-create-notifier.adoc @@ -2,23 +2,9 @@ // // * command-reference/roxctl-declarative-config.adoc -:_mod-docs-content-type: REFERENCE +:_mod-docs-content-type: CONCEPT [id="roxctl-declarative-config-create-notifier_{context}"] = roxctl declarative-config create notifier +[role="_abstract"] Create a declarative configuration for a notifier. - -.Usage -[source,terminal] ----- -$ roxctl declarative-config create notifier [flags] ----- - -.Options -[cols="2,2",options="header"] -|=== -|Option |Description - -|`--name string` -|Specify the name of the notifier. -|=== \ No newline at end of file diff --git a/modules/roxctl-declarative-config-create-options.adoc b/modules/roxctl-declarative-config-create-options.adoc new file mode 100644 index 000000000000..ae8e2b02c64c --- /dev/null +++ b/modules/roxctl-declarative-config-create-options.adoc @@ -0,0 +1,24 @@ +// Module included in the following assemblies: +// +// * command-reference/roxctl-declarative-config.adoc + +:_mod-docs-content-type: REFERENCE +[id="roxctl-declarative-config-create-options_{context}"] += Options + +[role="_abstract"] +Options for the `roxctl declarative-config create` command. + +[cols="2,2",options="header"] +|=== +|Option |Description + +|`--config-map string` +|Write the declarative configuration YAML in the config map. If not specified and the `--secret` flag is also not specified, the command prints the generated YAML in the standard output format. + +|`--namespace string` +|Required if you want to write the declarative configuration YAML to a config map or secret. If not specified, the command uses the default namespace in the current Kubernetes configuration. + +|`--secret string` +|Write the declarative configuration YAML in the Secret. You must use secrets for sensitive data. If not specified and the `--config-map` flag is also not specified, the command prints the generated YAML in the standard output format. +|=== diff --git a/modules/roxctl-declarative-config-create-permission-set-options.adoc b/modules/roxctl-declarative-config-create-permission-set-options.adoc new file mode 100644 index 000000000000..18aadaa74648 --- /dev/null +++ b/modules/roxctl-declarative-config-create-permission-set-options.adoc @@ -0,0 +1,24 @@ +// Module included in the following assemblies: +// +// * command-reference/roxctl-declarative-config.adoc + +:_mod-docs-content-type: REFERENCE +[id="roxctl-declarative-config-create-permission-set-options_{context}"] += Options + +[role="_abstract"] +Options for the `roxctl declarative-config create permission-set` command. + +[cols="6,3",options="header"] +|=== +|Option |Description + +|`--description string` +|Set the description of the permission set. + +|`--name string` +|Specify the name of the permission set. + +|`--resource-with-access stringToString` +|Set a list of resources with their respective access levels. The default value is `[]`. For more details, run the `roxctl declarative-config create permission-set --help` command. +|=== diff --git a/modules/roxctl-declarative-config-create-permission-set-usage.adoc b/modules/roxctl-declarative-config-create-permission-set-usage.adoc new file mode 100644 index 000000000000..0d43be3d0fa5 --- /dev/null +++ b/modules/roxctl-declarative-config-create-permission-set-usage.adoc @@ -0,0 +1,16 @@ +// Module included in the following assemblies: +// +// * command-reference/roxctl-declarative-config.adoc + +:_mod-docs-content-type: REFERENCE +[id="roxctl-declarative-config-create-permission-set-usage_{context}"] += roxctl declarative-config create permission-set usage + +[role="_abstract"] +Usage syntax for the `roxctl declarative-config create permission-set` command. + +.Usage +[source,terminal] +---- +$ roxctl declarative-config create permission-set [flags] +---- diff --git a/modules/roxctl-declarative-config-create-permission-set.adoc b/modules/roxctl-declarative-config-create-permission-set.adoc index 710e667c848f..71caab0795c9 100644 --- a/modules/roxctl-declarative-config-create-permission-set.adoc +++ b/modules/roxctl-declarative-config-create-permission-set.adoc @@ -2,29 +2,9 @@ // // * command-reference/roxctl-declarative-config.adoc -:_mod-docs-content-type: REFERENCE +:_mod-docs-content-type: CONCEPT [id="roxctl-declarative-config-create-permission-set_{context}"] = roxctl declarative-config create permission-set +[role="_abstract"] Create a declarative configuration for a permission set. - -.Usage -[source,terminal] ----- -$ roxctl declarative-config create permission-set [flags] ----- - -.Options -[cols="6,3",options="header"] -|=== -|Option |Description - -|`--description string` -|Set the description of the permission set. - -|`--name string` -|Specify the name of the permission set. - -|`--resource-with-access stringToString` -|Set a list of resources with their respective access levels. The default value is `[]`. For more details, run the `roxctl declarative-config create permission-set --help` command. -|=== \ No newline at end of file diff --git a/modules/roxctl-declarative-config-create-role-options.adoc b/modules/roxctl-declarative-config-create-role-options.adoc new file mode 100644 index 000000000000..4c3a91591bae --- /dev/null +++ b/modules/roxctl-declarative-config-create-role-options.adoc @@ -0,0 +1,27 @@ +// Module included in the following assemblies: +// +// * command-reference/roxctl-declarative-config.adoc + +:_mod-docs-content-type: REFERENCE +[id="roxctl-declarative-config-create-role-options_{context}"] += Options + +[role="_abstract"] +Options for the `roxctl declarative-config create role` command. + +[cols="2,2",options="header"] +|=== +|Option |Description + +|`--access-scope string` +|By providing the name, you can specify the referenced access scope. + +|`--description string` +|Set a description for the role. + +|`--name string` +|Specify the name of the role. + +|`--permission-set string` +|By providing the name, you can specify the referenced permission set. +|=== diff --git a/modules/roxctl-declarative-config-create-role-usage.adoc b/modules/roxctl-declarative-config-create-role-usage.adoc new file mode 100644 index 000000000000..c4cd178b46e4 --- /dev/null +++ b/modules/roxctl-declarative-config-create-role-usage.adoc @@ -0,0 +1,16 @@ +// Module included in the following assemblies: +// +// * command-reference/roxctl-declarative-config.adoc + +:_mod-docs-content-type: REFERENCE +[id="roxctl-declarative-config-create-role-usage_{context}"] += roxctl declarative-config create role usage + +[role="_abstract"] +Usage syntax for the `roxctl declarative-config create role` command. + +.Usage +[source,terminal] +---- +$ roxctl declarative-config create role [flags] +---- diff --git a/modules/roxctl-declarative-config-create-role.adoc b/modules/roxctl-declarative-config-create-role.adoc index 5cb7030905d5..6cc53641e0cf 100644 --- a/modules/roxctl-declarative-config-create-role.adoc +++ b/modules/roxctl-declarative-config-create-role.adoc @@ -2,32 +2,9 @@ // // * command-reference/roxctl-declarative-config.adoc -:_mod-docs-content-type: REFERENCE +:_mod-docs-content-type: CONCEPT [id="roxctl-declarative-config-create-role_{context}"] = roxctl declarative-config create role +[role="_abstract"] Create a declarative configuration for a role. - -.Usage -[source,terminal] ----- -$ roxctl declarative-config create role [flags] ----- - -.Options -[cols="2,2",options="header"] -|=== -|Option |Description - -|`--access-scope string` -|By providing the name, you can specify the referenced access scope. - -|`--description string` -|Set a description for the role. - -|`--name string` -|Specify the name of the role. - -|`--permission-set string` -|By providing the name, you can specify the referenced permission set. -|=== \ No newline at end of file diff --git a/modules/roxctl-declarative-config-create-usage.adoc b/modules/roxctl-declarative-config-create-usage.adoc new file mode 100644 index 000000000000..2178e457a559 --- /dev/null +++ b/modules/roxctl-declarative-config-create-usage.adoc @@ -0,0 +1,16 @@ +// Module included in the following assemblies: +// +// * command-reference/roxctl-declarative-config.adoc + +:_mod-docs-content-type: REFERENCE +[id="roxctl-declarative-config-create-usage_{context}"] += roxctl declarative-config create usage + +[role="_abstract"] +Usage syntax for the `roxctl declarative-config create` command. + +.Usage +[source,terminal] +---- +$ roxctl declarative-config create [flags] +---- diff --git a/modules/roxctl-declarative-config-create.adoc b/modules/roxctl-declarative-config-create.adoc index 560877bacb0c..02331b02b5b3 100644 --- a/modules/roxctl-declarative-config-create.adoc +++ b/modules/roxctl-declarative-config-create.adoc @@ -2,29 +2,9 @@ // // * command-reference/roxctl-declarative-config.adoc -:_mod-docs-content-type: REFERENCE +:_mod-docs-content-type: CONCEPT [id="roxctl-declarative-config-create_{context}"] = roxctl declarative-config create +[role="_abstract"] Create declarative configurations. - -.Usage -[source,terminal] ----- -$ roxctl declarative-config create [flags] ----- - -.Options -[cols="2,2",options="header"] -|=== -|Option |Description - -|`--config-map string` -|Write the declarative configuration YAML in the configuration map. If not specified and the `--secret` flag is also not specified, the generated YAML is printed in the standard output format. - -|`--namespace string` -|Required if you want to write the declarative configuration YAML to a configuration map or secret. If not specified, the default namespace in the current Kubernetes configuration is used. - -|`--secret string` -|Write the declarative configuration YAML in the Secret. You must use secrets for sensitive data. If not specified and the `--config-map` flag is also not specified, the generated YAML is printed in the standard output format. -|=== \ No newline at end of file diff --git a/modules/roxctl-declarative-config-lint-options.adoc b/modules/roxctl-declarative-config-lint-options.adoc new file mode 100644 index 000000000000..12177c653b9d --- /dev/null +++ b/modules/roxctl-declarative-config-lint-options.adoc @@ -0,0 +1,27 @@ +// Module included in the following assemblies: +// +// * command-reference/roxctl-declarative-config.adoc + +:_mod-docs-content-type: REFERENCE +[id="roxctl-declarative-config-lint-options_{context}"] += Options + +[role="_abstract"] +Options for the `roxctl declarative-config lint` command. + +[cols="2,2",options="header"] +|=== +|Option |Description + +|`--config-map string` +|Read the declarative configuration from the `--config-map string`. If not specified, the command reads the configuration from the YAML file specified by using the `--file` flag. + +|`-f`, `--file string` +|File containing the declarative configuration in YAML format. + +|`--namespace string` +|Read the declarative configuration from the `--namespace string` of the config map. If not specified, the command uses the namespace specified in the current Kubernetes configuration context. + +|`--secret string` +|Read the declarative configuration from the specified `--secret string`. If not specified, the command reads the configuration from the YAML file specified by using the `--file` flag. +|=== diff --git a/modules/roxctl-declarative-config-lint-usage.adoc b/modules/roxctl-declarative-config-lint-usage.adoc new file mode 100644 index 000000000000..6148c7b97a86 --- /dev/null +++ b/modules/roxctl-declarative-config-lint-usage.adoc @@ -0,0 +1,16 @@ +// Module included in the following assemblies: +// +// * command-reference/roxctl-declarative-config.adoc + +:_mod-docs-content-type: REFERENCE +[id="roxctl-declarative-config-lint-usage_{context}"] += roxctl declarative-config lint usage + +[role="_abstract"] +Usage syntax for the `roxctl declarative-config lint` command. + +.Usage +[source,terminal] +---- +$ roxctl declarative-config lint [flags] +---- diff --git a/modules/roxctl-declarative-config-lint.adoc b/modules/roxctl-declarative-config-lint.adoc index 0d413bcd5be9..1c7a3667dd79 100644 --- a/modules/roxctl-declarative-config-lint.adoc +++ b/modules/roxctl-declarative-config-lint.adoc @@ -2,32 +2,9 @@ // // * command-reference/roxctl-declarative-config.adoc -:_mod-docs-content-type: REFERENCE +:_mod-docs-content-type: CONCEPT [id="roxctl-declarative-config-lint_{context}"] = roxctl declarative-config lint +[role="_abstract"] Lint an existing declarative configuration YAML file. - -.Usage -[source,terminal] ----- -$ roxctl declarative-config lint [flags] ----- - -.Options -[cols="2,2",options="header"] -|=== -|Option |Description - -|`--config-map string` -|Read the declarative configuration from the `--config-map string`. If not specified, the configuration is read from the YAML file specified by using the `--file` flag. - -|`-f`, `--file string` -|File containing the declarative configuration in YAML format. - -|`--namespace string` -|Read the declarative configuration from the `--namespace string` of the configuration map. If not specified, the namespace specified in the current Kubernetes configuration context is used. - -|`--secret string` -|Read the declarative configuration from the specified `--secret string`. If not specified, the configuration is read from the YAML file specified by using the `--file` flag. -|=== \ No newline at end of file diff --git a/modules/roxctl-declarative-config-overview.adoc b/modules/roxctl-declarative-config-overview.adoc new file mode 100644 index 000000000000..7bb1e691eb02 --- /dev/null +++ b/modules/roxctl-declarative-config-overview.adoc @@ -0,0 +1,10 @@ +// Module included in the following assemblies: +// +// * command-reference/roxctl-declarative-config.adoc + +:_mod-docs-content-type: CONCEPT +[id="roxctl-declarative-config-overview_{context}"] += roxctl declarative-config + +[role="_abstract"] +Manage the declarative configuration. diff --git a/modules/roxctl-declarative-config-usage.adoc b/modules/roxctl-declarative-config-usage.adoc new file mode 100644 index 000000000000..b59d4d07a738 --- /dev/null +++ b/modules/roxctl-declarative-config-usage.adoc @@ -0,0 +1,16 @@ +// Module included in the following assemblies: +// +// * command-reference/roxctl-declarative-config.adoc + +:_mod-docs-content-type: REFERENCE +[id="roxctl-declarative-config-usage_{context}"] += roxctl declarative-config usage + +[role="_abstract"] +Usage syntax for the `roxctl declarative-config` command. + +.Usage +[source,terminal] +---- +$ roxctl declarative-config [command] [flags] +----