feat(alb): updated documentation

bahkauv70 · bahkauv70 · commit df0449ec2dd4 · 2025-04-10T16:08:59.000+02:00
diff --git a/docs/stackit_beta.md b/docs/stackit_beta.md
@@ -41,5 +41,6 @@ stackit beta [flags]
 ### SEE ALSO
 
 * [stackit](./stackit.md)	 - Manage STACKIT resources using the command line
+* [stackit beta alb](./stackit_beta_alb.md)	 - Manages application loadbalancers
 * [stackit beta sqlserverflex](./stackit_beta_sqlserverflex.md)	 - Provides functionality for SQLServer Flex
 
diff --git a/docs/stackit_beta_alb.md b/docs/stackit_beta_alb.md
@@ -0,0 +1,40 @@
+## stackit beta alb
+
+Manages application loadbalancers
+
+### Synopsis
+
+Manage the lifecycle of application loadbalancers.
+
+```
+stackit beta alb [flags]
+```
+
+### Options
+
+```
+  -h, --help   Help for "stackit beta alb"
+```
+
+### Options inherited from parent commands
+
+```
+  -y, --assume-yes             If set, skips all confirmation prompts
+      --async                  If set, runs the command asynchronously
+  -o, --output-format string   Output format, one of ["json" "pretty" "none" "yaml"]
+  -p, --project-id string      Project ID
+      --region string          Target region for region-specific requests
+      --verbosity string       Verbosity of the CLI, one of ["debug" "info" "warning" "error"] (default "info")
+```
+
+### SEE ALSO
+
+* [stackit beta](./stackit_beta.md)	 - Contains beta STACKIT CLI commands
+* [stackit beta alb create](./stackit_beta_alb_create.md)	 - Creates an application loadbalancer
+* [stackit beta alb delete](./stackit_beta_alb_delete.md)	 - Deletes an application loadbalancer
+* [stackit beta alb describe](./stackit_beta_alb_describe.md)	 - Describes an application loadbalancer
+* [stackit beta alb list](./stackit_beta_alb_list.md)	 - Lists albs
+* [stackit beta alb pool](./stackit_beta_alb_pool.md)	 - Manages target pools for application loadbalancers
+* [stackit beta alb template](./stackit_beta_alb_template.md)	 - creates configuration templates to use for resource creation
+* [stackit beta alb update](./stackit_beta_alb_update.md)	 - Updates an application loadbalancer
+
diff --git a/docs/stackit_beta_alb_create.md b/docs/stackit_beta_alb_create.md
@@ -0,0 +1,41 @@
+## stackit beta alb create
+
+Creates an application loadbalancer
+
+### Synopsis
+
+Creates an application loadbalancer.
+
+```
+stackit beta alb create [flags]
+```
+
+### Examples
+
+```
+  Create an application loadbalancer from a configuration file
+  $ stackit beta alb create --configuration my-loadbalancer.json
+```
+
+### Options
+
+```
+  -c, --configuration string   filename of the input configuration file
+  -h, --help                   Help for "stackit beta alb create"
+```
+
+### Options inherited from parent commands
+
+```
+  -y, --assume-yes             If set, skips all confirmation prompts
+      --async                  If set, runs the command asynchronously
+  -o, --output-format string   Output format, one of ["json" "pretty" "none" "yaml"]
+  -p, --project-id string      Project ID
+      --region string          Target region for region-specific requests
+      --verbosity string       Verbosity of the CLI, one of ["debug" "info" "warning" "error"] (default "info")
+```
+
+### SEE ALSO
+
+* [stackit beta alb](./stackit_beta_alb.md)	 - Manages application loadbalancers
+
diff --git a/docs/stackit_beta_alb_delete.md b/docs/stackit_beta_alb_delete.md
@@ -0,0 +1,40 @@
+## stackit beta alb delete
+
+Deletes an application loadbalancer
+
+### Synopsis
+
+Deletes an application loadbalancer.
+
+```
+stackit beta alb delete LOADBALANCER_NAME_ARG [flags]
+```
+
+### Examples
+
+```
+  Delete an application loadbalancer with name "my-load-balancer"
+  $ stackit beta alb delete my-load-balancer
+```
+
+### Options
+
+```
+  -h, --help   Help for "stackit beta alb delete"
+```
+
+### Options inherited from parent commands
+
+```
+  -y, --assume-yes             If set, skips all confirmation prompts
+      --async                  If set, runs the command asynchronously
+  -o, --output-format string   Output format, one of ["json" "pretty" "none" "yaml"]
+  -p, --project-id string      Project ID
+      --region string          Target region for region-specific requests
+      --verbosity string       Verbosity of the CLI, one of ["debug" "info" "warning" "error"] (default "info")
+```
+
+### SEE ALSO
+
+* [stackit beta alb](./stackit_beta_alb.md)	 - Manages application loadbalancers
+
diff --git a/docs/stackit_beta_alb_describe.md b/docs/stackit_beta_alb_describe.md
@@ -0,0 +1,40 @@
+## stackit beta alb describe
+
+Describes an application loadbalancer
+
+### Synopsis
+
+Describes an application loadbalancer.
+
+```
+stackit beta alb describe LOADBALANCER_NAME_ARG [flags]
+```
+
+### Examples
+
+```
+  Get details about an application loadbalancer with name "my-load-balancer"
+  $ stackit beta alb describe my-load-balancer
+```
+
+### Options
+
+```
+  -h, --help   Help for "stackit beta alb describe"
+```
+
+### Options inherited from parent commands
+
+```
+  -y, --assume-yes             If set, skips all confirmation prompts
+      --async                  If set, runs the command asynchronously
+  -o, --output-format string   Output format, one of ["json" "pretty" "none" "yaml"]
+  -p, --project-id string      Project ID
+      --region string          Target region for region-specific requests
+      --verbosity string       Verbosity of the CLI, one of ["debug" "info" "warning" "error"] (default "info")
+```
+
+### SEE ALSO
+
+* [stackit beta alb](./stackit_beta_alb.md)	 - Manages application loadbalancers
+
diff --git a/docs/stackit_beta_alb_list.md b/docs/stackit_beta_alb_list.md
@@ -0,0 +1,44 @@
+## stackit beta alb list
+
+Lists albs
+
+### Synopsis
+
+Lists application load balancers.
+
+```
+stackit beta alb list [flags]
+```
+
+### Examples
+
+```
+  List all load balancers
+  $ stackit beta alb list
+
+  List the first 10 application load balancers
+  $ stackit beta alb list --limit=10
+```
+
+### Options
+
+```
+  -h, --help        Help for "stackit beta alb list"
+      --limit int   Limit the output to the first n elements
+```
+
+### Options inherited from parent commands
+
+```
+  -y, --assume-yes             If set, skips all confirmation prompts
+      --async                  If set, runs the command asynchronously
+  -o, --output-format string   Output format, one of ["json" "pretty" "none" "yaml"]
+  -p, --project-id string      Project ID
+      --region string          Target region for region-specific requests
+      --verbosity string       Verbosity of the CLI, one of ["debug" "info" "warning" "error"] (default "info")
+```
+
+### SEE ALSO
+
+* [stackit beta alb](./stackit_beta_alb.md)	 - Manages application loadbalancers
+
diff --git a/docs/stackit_beta_alb_pool.md b/docs/stackit_beta_alb_pool.md
@@ -0,0 +1,34 @@
+## stackit beta alb pool
+
+Manages target pools for application loadbalancers
+
+### Synopsis
+
+Manage the lifecycle of target pools for application loadbalancers.
+
+```
+stackit beta alb pool [flags]
+```
+
+### Options
+
+```
+  -h, --help   Help for "stackit beta alb pool"
+```
+
+### Options inherited from parent commands
+
+```
+  -y, --assume-yes             If set, skips all confirmation prompts
+      --async                  If set, runs the command asynchronously
+  -o, --output-format string   Output format, one of ["json" "pretty" "none" "yaml"]
+  -p, --project-id string      Project ID
+      --region string          Target region for region-specific requests
+      --verbosity string       Verbosity of the CLI, one of ["debug" "info" "warning" "error"] (default "info")
+```
+
+### SEE ALSO
+
+* [stackit beta alb](./stackit_beta_alb.md)	 - Manages application loadbalancers
+* [stackit beta alb pool update](./stackit_beta_alb_pool_update.md)	 - Updates an application target pool
+
diff --git a/docs/stackit_beta_alb_pool_update.md b/docs/stackit_beta_alb_pool_update.md
@@ -0,0 +1,42 @@
+## stackit beta alb pool update
+
+Updates an application target pool
+
+### Synopsis
+
+Updates an application target pool.
+
+```
+stackit beta alb pool update [flags]
+```
+
+### Examples
+
+```
+  Update an application target pool from a configuration file (the name of the pool is read from the file)
+  $ stackit beta alb update --configuration my-target-pool.json --name my-load-balancer
+```
+
+### Options
+
+```
+  -c, --configuration string   filename of the input configuration file
+  -h, --help                   Help for "stackit beta alb pool update"
+  -n, --name string            name of the target pool name to update
+```
+
+### Options inherited from parent commands
+
+```
+  -y, --assume-yes             If set, skips all confirmation prompts
+      --async                  If set, runs the command asynchronously
+  -o, --output-format string   Output format, one of ["json" "pretty" "none" "yaml"]
+  -p, --project-id string      Project ID
+      --region string          Target region for region-specific requests
+      --verbosity string       Verbosity of the CLI, one of ["debug" "info" "warning" "error"] (default "info")
+```
+
+### SEE ALSO
+
+* [stackit beta alb pool](./stackit_beta_alb_pool.md)	 - Manages target pools for application loadbalancers
+
diff --git a/docs/stackit_beta_alb_template.md b/docs/stackit_beta_alb_template.md
@@ -0,0 +1,45 @@
+## stackit beta alb template
+
+creates configuration templates to use for resource creation
+
+### Synopsis
+
+creates a json or yaml template file for creating/updating an application loadbalancer or target pool.
+
+```
+stackit beta alb template [flags]
+```
+
+### Examples
+
+```
+  Create a yaml template
+  $ stackit beta alb template --format=yaml --type alb
+
+  Create a json template
+  $ stackit beta alb template --format=json --type pool
+```
+
+### Options
+
+```
+  -f, --format string   Defines the output format ('yaml' or 'json'), default is 'json' (default "json")
+  -h, --help            Help for "stackit beta alb template"
+  -t, --type string     Defines the output type ('alb' or 'pool'), default is 'alb' (default "alb")
+```
+
+### Options inherited from parent commands
+
+```
+  -y, --assume-yes             If set, skips all confirmation prompts
+      --async                  If set, runs the command asynchronously
+  -o, --output-format string   Output format, one of ["json" "pretty" "none" "yaml"]
+  -p, --project-id string      Project ID
+      --region string          Target region for region-specific requests
+      --verbosity string       Verbosity of the CLI, one of ["debug" "info" "warning" "error"] (default "info")
+```
+
+### SEE ALSO
+
+* [stackit beta alb](./stackit_beta_alb.md)	 - Manages application loadbalancers
+
diff --git a/docs/stackit_beta_alb_update.md b/docs/stackit_beta_alb_update.md
@@ -0,0 +1,41 @@
+## stackit beta alb update
+
+Updates an application loadbalancer
+
+### Synopsis
+
+Updates an application loadbalancer.
+
+```
+stackit beta alb update [flags]
+```
+
+### Examples
+
+```
+  Update an application loadbalancer from a configuration file
+  $ stackit beta alb update --configuration my-loadbalancer.json
+```
+
+### Options
+
+```
+  -c, --configuration string   filename of the input configuration file
+  -h, --help                   Help for "stackit beta alb update"
+```
+
+### Options inherited from parent commands
+
+```
+  -y, --assume-yes             If set, skips all confirmation prompts
+      --async                  If set, runs the command asynchronously
+  -o, --output-format string   Output format, one of ["json" "pretty" "none" "yaml"]
+  -p, --project-id string      Project ID
+      --region string          Target region for region-specific requests
+      --verbosity string       Verbosity of the CLI, one of ["debug" "info" "warning" "error"] (default "info")
+```
+
+### SEE ALSO
+
+* [stackit beta alb](./stackit_beta_alb.md)	 - Manages application loadbalancers
+
