doc: update pro cli docs

distribworks · Oct 6, 2024 · 1a9b3d8 · 1a9b3d8
1 parent 8e868c5
commit 1a9b3d8
Show file tree

Hide file tree

Showing 25 changed files with 445 additions and 39 deletions.
diff --git a/website/docs/pro/cli/dkron.md b/website/docs/pro/cli/dkron.md
@@ -1,5 +1,5 @@
 ---
-date: 2023-09-02
+date: 2024-10-06
 title: "dkron"
 slug: dkron
 url: /docs/pro/cli/dkron/
@@ -23,6 +23,7 @@ If a machine fails (the leader), a follower will take over and keep running the
 
 ### SEE ALSO
 
+* [dkron acl](/docs/pro/cli/dkron_acl/)	 - Control ACL policies
 * [dkron agent](/docs/pro/cli/dkron_agent/)	 - Start a dkron agent
 * [dkron completion](/docs/pro/cli/dkron_completion/)	 - Generate the autocompletion script for the specified shell
 * [dkron doc](/docs/pro/cli/dkron_doc/)	 - Generate Markdown documentation for the Dkron CLI.
@@ -31,4 +32,4 @@ If a machine fails (the leader), a follower will take over and keep running the
 * [dkron raft](/docs/pro/cli/dkron_raft/)	 - Command to perform some raft operations
 * [dkron version](/docs/pro/cli/dkron_version/)	 - Show version
 
-###### Auto generated by spf13/cobra on 2-Sep-2023
+###### Auto generated by spf13/cobra on 6-Oct-2024
diff --git a/website/docs/pro/cli/dkron_acl.md b/website/docs/pro/cli/dkron_acl.md
@@ -0,0 +1,38 @@
+---
+date: 2024-10-06
+title: "dkron acl"
+slug: dkron_acl
+url: /docs/pro/cli/dkron_acl/
+---
+## dkron acl
+
+Control ACL policies
+
+### Synopsis
+
+Control ACL policies. This command allows to manage ACL policies.
+
+### Options
+
+```
+      --cert-file string         Path to the client server TLS cert file
+  -h, --help                     help for acl
+      --key-file string          Path to the client server TLS key file
+      --rpc-addr string          gRPC address of the agent (default "127.0.0.1:6868")
+      --trusted-ca-file string   Path to the client server TLS trusted CA cert file
+```
+
+### Options inherited from parent commands
+
+```
+      --config string   config file (default is /etc/dkron/dkron.yml)
+```
+
+### SEE ALSO
+
+* [dkron](/docs/pro/cli/dkron/)	 - Professional distributed job scheduling system
+* [dkron acl bootstrap](/docs/pro/cli/dkron_acl_bootstrap/)	 - Bootstrap ACL policies
+* [dkron acl policy](/docs/pro/cli/dkron_acl_policy/)	 - Operate ACL policies
+* [dkron acl token](/docs/pro/cli/dkron_acl_token/)	 - Operate ACL tokens
+
+###### Auto generated by spf13/cobra on 6-Oct-2024
diff --git a/website/docs/pro/cli/dkron_acl_bootstrap.md b/website/docs/pro/cli/dkron_acl_bootstrap.md
@@ -0,0 +1,36 @@
+---
+date: 2024-10-06
+title: "dkron acl bootstrap"
+slug: dkron_acl_bootstrap
+url: /docs/pro/cli/dkron_acl_bootstrap/
+---
+## dkron acl bootstrap
+
+Bootstrap ACL policies
+
+### Synopsis
+
+Bootstrap ACL policies. This command allows to bootstrap ACL policies.
+
+```
+dkron acl bootstrap [flags]
+```
+
+### Options
+
+```
+  -h, --help   help for bootstrap
+```
+
+### Options inherited from parent commands
+
+```
+      --config string     config file (default is /etc/dkron/dkron.yml)
+      --rpc-addr string   gRPC address of the agent (default "127.0.0.1:6868")
+```
+
+### SEE ALSO
+
+* [dkron acl](/docs/pro/cli/dkron_acl/)	 - Control ACL policies
+
+###### Auto generated by spf13/cobra on 6-Oct-2024
diff --git a/website/docs/pro/cli/dkron_acl_policy.md b/website/docs/pro/cli/dkron_acl_policy.md
@@ -0,0 +1,36 @@
+---
+date: 2024-10-06
+title: "dkron acl policy"
+slug: dkron_acl_policy
+url: /docs/pro/cli/dkron_acl_policy/
+---
+## dkron acl policy
+
+Operate ACL policies
+
+### Synopsis
+
+Operate ACL policies. This command allows to manage ACL policies.
+
+### Options
+
+```
+  -h, --help   help for policy
+```
+
+### Options inherited from parent commands
+
+```
+      --config string     config file (default is /etc/dkron/dkron.yml)
+      --rpc-addr string   gRPC address of the agent (default "127.0.0.1:6868")
+```
+
+### SEE ALSO
+
+* [dkron acl](/docs/pro/cli/dkron_acl/)	 - Control ACL policies
+* [dkron acl policy apply](/docs/pro/cli/dkron_acl_policy_apply/)	 - Apply ACL policies
+* [dkron acl policy delete](/docs/pro/cli/dkron_acl_policy_delete/)	 - Delete ACL policies
+* [dkron acl policy info](/docs/pro/cli/dkron_acl_policy_info/)	 - Info ACL policy
+* [dkron acl policy list](/docs/pro/cli/dkron_acl_policy_list/)	 - List ACL policies
+
+###### Auto generated by spf13/cobra on 6-Oct-2024
diff --git a/website/docs/pro/cli/dkron_acl_policy_apply.md b/website/docs/pro/cli/dkron_acl_policy_apply.md
@@ -0,0 +1,41 @@
+---
+date: 2024-10-06
+title: "dkron acl policy apply"
+slug: dkron_acl_policy_apply
+url: /docs/pro/cli/dkron_acl_policy_apply/
+---
+## dkron acl policy apply
+
+Apply ACL policies
+
+### Synopsis
+
+Apply ACL policies. This command allows to apply ACL policies.
+
+```
+dkron acl policy apply [flags]
+```
+
+### Options
+
+```
+      --cert-file string         Path to the client server TLS cert file
+  -h, --help                     help for apply
+      --key-file string          Path to the client server TLS key file
+  -n, --name string              Policy name
+      --rpc-addr string          gRPC address of the agent (default "127.0.0.1:6868")
+  -r, --rules-file string        Path to the file containing the policy rules
+      --trusted-ca-file string   Path to the client server TLS trusted CA cert file
+```
+
+### Options inherited from parent commands
+
+```
+      --config string   config file (default is /etc/dkron/dkron.yml)
+```
+
+### SEE ALSO
+
+* [dkron acl policy](/docs/pro/cli/dkron_acl_policy/)	 - Operate ACL policies
+
+###### Auto generated by spf13/cobra on 6-Oct-2024
diff --git a/website/docs/pro/cli/dkron_acl_policy_delete.md b/website/docs/pro/cli/dkron_acl_policy_delete.md
@@ -0,0 +1,39 @@
+---
+date: 2024-10-06
+title: "dkron acl policy delete"
+slug: dkron_acl_policy_delete
+url: /docs/pro/cli/dkron_acl_policy_delete/
+---
+## dkron acl policy delete
+
+Delete ACL policies
+
+### Synopsis
+
+Delete ACL policies. This command allows to apply ACL policies.
+
+```
+dkron acl policy delete [flags]
+```
+
+### Options
+
+```
+      --cert-file string         Path to the client server TLS cert file
+  -h, --help                     help for delete
+      --key-file string          Path to the client server TLS key file
+      --rpc-addr string          gRPC address of the agent (default "127.0.0.1:6868")
+      --trusted-ca-file string   Path to the client server TLS trusted CA cert file
+```
+
+### Options inherited from parent commands
+
+```
+      --config string   config file (default is /etc/dkron/dkron.yml)
+```
+
+### SEE ALSO
+
+* [dkron acl policy](/docs/pro/cli/dkron_acl_policy/)	 - Operate ACL policies
+
+###### Auto generated by spf13/cobra on 6-Oct-2024
diff --git a/website/docs/pro/cli/dkron_acl_policy_info.md b/website/docs/pro/cli/dkron_acl_policy_info.md
@@ -0,0 +1,36 @@
+---
+date: 2024-10-06
+title: "dkron acl policy info"
+slug: dkron_acl_policy_info
+url: /docs/pro/cli/dkron_acl_policy_info/
+---
+## dkron acl policy info
+
+Info ACL policy
+
+### Synopsis
+
+Info ACL policy. Print policy details.
+
+```
+dkron acl policy info [flags]
+```
+
+### Options
+
+```
+  -h, --help   help for info
+```
+
+### Options inherited from parent commands
+
+```
+      --config string     config file (default is /etc/dkron/dkron.yml)
+      --rpc-addr string   gRPC address of the agent (default "127.0.0.1:6868")
+```
+
+### SEE ALSO
+
+* [dkron acl policy](/docs/pro/cli/dkron_acl_policy/)	 - Operate ACL policies
+
+###### Auto generated by spf13/cobra on 6-Oct-2024
diff --git a/website/docs/pro/cli/dkron_acl_policy_list.md b/website/docs/pro/cli/dkron_acl_policy_list.md
@@ -0,0 +1,36 @@
+---
+date: 2024-10-06
+title: "dkron acl policy list"
+slug: dkron_acl_policy_list
+url: /docs/pro/cli/dkron_acl_policy_list/
+---
+## dkron acl policy list
+
+List ACL policies
+
+### Synopsis
+
+List ACL policies. This command allows to list ACL policies.
+
+```
+dkron acl policy list [flags]
+```
+
+### Options
+
+```
+  -h, --help   help for list
+```
+
+### Options inherited from parent commands
+
+```
+      --config string     config file (default is /etc/dkron/dkron.yml)
+      --rpc-addr string   gRPC address of the agent (default "127.0.0.1:6868")
+```
+
+### SEE ALSO
+
+* [dkron acl policy](/docs/pro/cli/dkron_acl_policy/)	 - Operate ACL policies
+
+###### Auto generated by spf13/cobra on 6-Oct-2024
diff --git a/website/docs/pro/cli/dkron_acl_token.md b/website/docs/pro/cli/dkron_acl_token.md
@@ -0,0 +1,35 @@
+---
+date: 2024-10-06
+title: "dkron acl token"
+slug: dkron_acl_token
+url: /docs/pro/cli/dkron_acl_token/
+---
+## dkron acl token
+
+Operate ACL tokens
+
+### Synopsis
+
+Operate ACL tokens. This command allows to manage ACL tokens.
+
+### Options
+
+```
+  -h, --help   help for token
+```
+
+### Options inherited from parent commands
+
+```
+      --config string     config file (default is /etc/dkron/dkron.yml)
+      --rpc-addr string   gRPC address of the agent (default "127.0.0.1:6868")
+```
+
+### SEE ALSO
+
+* [dkron acl](/docs/pro/cli/dkron_acl/)	 - Control ACL policies
+* [dkron acl token create](/docs/pro/cli/dkron_acl_token_create/)	 - Create a new ACL token
+* [dkron acl token info](/docs/pro/cli/dkron_acl_token_info/)	 - Print ACL token details
+* [dkron acl token list](/docs/pro/cli/dkron_acl_token_list/)	 - List ACL tokens
+
+###### Auto generated by spf13/cobra on 6-Oct-2024
diff --git a/website/docs/pro/cli/dkron_acl_token_create.md b/website/docs/pro/cli/dkron_acl_token_create.md
@@ -0,0 +1,42 @@
+---
+date: 2024-10-06
+title: "dkron acl token create"
+slug: dkron_acl_token_create
+url: /docs/pro/cli/dkron_acl_token_create/
+---
+## dkron acl token create
+
+Create a new ACL token
+
+### Synopsis
+
+Create a new ACL token. This command allows to create a new ACL token.
+
+```
+dkron acl token create [flags]
+```
+
+### Options
+
+```
+      --cert-file string         Path to the client server TLS cert file
+  -h, --help                     help for create
+      --key-file string          Path to the client server TLS key file
+  -n, --name string              Sets the human readable name for the ACL token.
+  -p, --policy strings           Specifies a policy to associate with the token. Can be specified multiple times, but only with client type tokens. (default [default])
+      --rpc-addr string          gRPC address of the agent (default "127.0.0.1:6868")
+      --trusted-ca-file string   Path to the client server TLS trusted CA cert file
+  -t, --type string              Sets the type of token. Must be one of "client" (default), or "management". (default "client")
+```
+
+### Options inherited from parent commands
+
+```
+      --config string   config file (default is /etc/dkron/dkron.yml)
+```
+
+### SEE ALSO
+
+* [dkron acl token](/docs/pro/cli/dkron_acl_token/)	 - Operate ACL tokens
+
+###### Auto generated by spf13/cobra on 6-Oct-2024