Skip to content
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.

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

WIP: chore: add lbaas #1308

Draft
wants to merge 7 commits into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
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 mgc/cli/docs/help.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ Usage:
- container-registry Magalu Container Registry product API.
- dbaas DBaaS API Product.
- kubernetes APIs related to the Kubernetes product.
- lbaas Lbaas RP API
- network VPC Api Product
- object-storage Operations for Object Storage
- virtual-machine Virtual Machine Api Product
Expand Down
42 changes: 42 additions & 0 deletions mgc/cli/docs/lbaas/application_backends/create/help.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
# Create Backend

## Usage:
```bash
Usage:
./mgc lbaas application-backends create [load-balancer-id] [flags]
```

## Product catalog:
- Flags:
- --balance-algorithm enum BackendBalanceAlgorithm (one of "least_connections", "round_robin" or "source_ip_hash") (required)
- --cli.list-links enum[=table] List all available links for this command (one of "json", "table" or "yaml")
- --description string Description
- --health-check-name string Health Check Name (required)
- -h, --help help for create
- --load-balancer-id string load_balancer_id: ID of the attached Load balancer (required)
- --name string Name (required)
- --targets array Targets (at least one of: array or array)
- Use --targets=help for more details (required)
- --targets-type enum BackendType (one of "instance" or "raw") (required)
- -v, --version version for create

## Other commands:
- Global Flags:
- --api-key string Use your API key to authenticate with the API
- -U, --cli.retry-until string Retry the action with the same parameters until the given condition is met. The flag parameters
- use the format: 'retries,interval,condition', where 'retries' is a positive integer, 'interval' is
- a duration (ex: 2s) and 'condition' is a 'engine=value' pair such as "jsonpath=expression"
- -t, --cli.timeout duration If > 0, it's the timeout for the action execution. It's specified as numbers and unit suffix.
- Valid unit suffixes: ns, us, ms, s, m and h. Examples: 300ms, 1m30s
- --debug Display detailed log information at the debug level
- --env enum Environment to use (one of "pre-prod" or "prod") (default "prod")
- --no-confirm Bypasses confirmation step for commands that ask a confirmation from the user
- -o, --output string Change the output format. Use '--output=help' to know more details.
- -r, --raw Output raw data, without any formatting or coloring
- --server-url uri Manually specify the server to use

## Flags:
```bash

```

35 changes: 35 additions & 0 deletions mgc/cli/docs/lbaas/application_backends/delete/help.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
# Delete Backend by ID

## Usage:
```bash
Usage:
./mgc lbaas application-backends delete [load-balancer-id] [backend-id] [flags]
```

## Product catalog:
- Flags:
- --backend-id string backend_id: ID of the backend you wanna delete (required)
- -h, --help help for delete
- --load-balancer-id string load_balancer_id: ID of the attached Load balancer (required)
- -v, --version version for delete

## Other commands:
- Global Flags:
- --api-key string Use your API key to authenticate with the API
- -U, --cli.retry-until string Retry the action with the same parameters until the given condition is met. The flag parameters
- use the format: 'retries,interval,condition', where 'retries' is a positive integer, 'interval' is
- a duration (ex: 2s) and 'condition' is a 'engine=value' pair such as "jsonpath=expression"
- -t, --cli.timeout duration If > 0, it's the timeout for the action execution. It's specified as numbers and unit suffix.
- Valid unit suffixes: ns, us, ms, s, m and h. Examples: 300ms, 1m30s
- --debug Display detailed log information at the debug level
- --env enum Environment to use (one of "pre-prod" or "prod") (default "prod")
- --no-confirm Bypasses confirmation step for commands that ask a confirmation from the user
- -o, --output string Change the output format. Use '--output=help' to know more details.
- -r, --raw Output raw data, without any formatting or coloring
- --server-url uri Manually specify the server to use

## Flags:
```bash

```

36 changes: 36 additions & 0 deletions mgc/cli/docs/lbaas/application_backends/get/help.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
# Get Backend by ID

## Usage:
```bash
Usage:
./mgc lbaas application-backends get [load-balancer-id] [backend-id] [flags]
```

## Product catalog:
- Flags:
- --backend-id string backend_id: ID of the backend you wanna fetch (required)
- --cli.list-links enum[=table] List all available links for this command (one of "json", "table" or "yaml")
- -h, --help help for get
- --load-balancer-id string load_balancer_id: ID of the attached Load balancer (required)
- -v, --version version for get

## Other commands:
- Global Flags:
- --api-key string Use your API key to authenticate with the API
- -U, --cli.retry-until string Retry the action with the same parameters until the given condition is met. The flag parameters
- use the format: 'retries,interval,condition', where 'retries' is a positive integer, 'interval' is
- a duration (ex: 2s) and 'condition' is a 'engine=value' pair such as "jsonpath=expression"
- -t, --cli.timeout duration If > 0, it's the timeout for the action execution. It's specified as numbers and unit suffix.
- Valid unit suffixes: ns, us, ms, s, m and h. Examples: 300ms, 1m30s
- --debug Display detailed log information at the debug level
- --env enum Environment to use (one of "pre-prod" or "prod") (default "prod")
- --no-confirm Bypasses confirmation step for commands that ask a confirmation from the user
- -o, --output string Change the output format. Use '--output=help' to know more details.
- -r, --raw Output raw data, without any formatting or coloring
- --server-url uri Manually specify the server to use

## Flags:
```bash

```

28 changes: 28 additions & 0 deletions mgc/cli/docs/lbaas/application_backends/help.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# Application Load Balancer Backends (Target Pools)

## Usage:
```bash
Usage:
./mgc lbaas application-backends [flags]
./mgc lbaas application-backends [command]
```

## Product catalog:
- Aliases:
- application-backends, application_backends

## Other commands:
- Commands:
- create Create Backend
- delete Delete Backend by ID
- get Get Backend by ID
- list List Backends
- replace Update Backend by ID

## Flags:
```bash
Flags:
-h, --help help for application-backends
-v, --version version for application-backends
```

37 changes: 37 additions & 0 deletions mgc/cli/docs/lbaas/application_backends/list/help.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
# List Backends

## Usage:
```bash
Usage:
./mgc lbaas application-backends list [load-balancer-id] [flags]
```

## Product catalog:
- Flags:
- --control.limit integer Items Per Page (min: 1) (default 10)
- --control.offset integer Page Number
- --control.sort string Sort: Name of the field which the list must be ordered by ending with :asc or :desc (default "created_at:desc")
- -h, --help help for list
- --load-balancer-id string load_balancer_id: ID of the attached Load balancer (required)
- -v, --version version for list

## Other commands:
- Global Flags:
- --api-key string Use your API key to authenticate with the API
- -U, --cli.retry-until string Retry the action with the same parameters until the given condition is met. The flag parameters
- use the format: 'retries,interval,condition', where 'retries' is a positive integer, 'interval' is
- a duration (ex: 2s) and 'condition' is a 'engine=value' pair such as "jsonpath=expression"
- -t, --cli.timeout duration If > 0, it's the timeout for the action execution. It's specified as numbers and unit suffix.
- Valid unit suffixes: ns, us, ms, s, m and h. Examples: 300ms, 1m30s
- --debug Display detailed log information at the debug level
- --env enum Environment to use (one of "pre-prod" or "prod") (default "prod")
- --no-confirm Bypasses confirmation step for commands that ask a confirmation from the user
- -o, --output string Change the output format. Use '--output=help' to know more details.
- -r, --raw Output raw data, without any formatting or coloring
- --server-url uri Manually specify the server to use

## Flags:
```bash

```

44 changes: 44 additions & 0 deletions mgc/cli/docs/lbaas/application_backends/replace/help.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
# Update Backend by ID

## Usage:
```bash
Usage:
./mgc lbaas application-backends replace [load-balancer-id] [backend-id] [flags]
```

## Product catalog:
- Flags:
- --backend-id string backend_id: ID of the backend you wanna update (required)
- --balance-algorithm enum BackendBalanceAlgorithm (one of "least_connections", "round_robin" or "source_ip_hash") (required)
- --cli.list-links enum[=table] List all available links for this command (one of "json", "table" or "yaml")
- --description string Description
- --force-authentication Force authentication by sending the header even if this API doesn't require it
- --health-check-name string Health Check Name (required)
- -h, --help help for replace
- --load-balancer-id string load_balancer_id: ID of the attached Load balancer (required)
- --name string Name (required)
- --targets array Targets (at least one of: array or array)
- Use --targets=help for more details (required)
- --targets-type enum BackendType (one of "instance" or "raw") (required)
- -v, --version version for replace

## Other commands:
- Global Flags:
- --api-key string Use your API key to authenticate with the API
- -U, --cli.retry-until string Retry the action with the same parameters until the given condition is met. The flag parameters
- use the format: 'retries,interval,condition', where 'retries' is a positive integer, 'interval' is
- a duration (ex: 2s) and 'condition' is a 'engine=value' pair such as "jsonpath=expression"
- -t, --cli.timeout duration If > 0, it's the timeout for the action execution. It's specified as numbers and unit suffix.
- Valid unit suffixes: ns, us, ms, s, m and h. Examples: 300ms, 1m30s
- --debug Display detailed log information at the debug level
- --env enum Environment to use (one of "pre-prod" or "prod") (default "prod")
- --no-confirm Bypasses confirmation step for commands that ask a confirmation from the user
- -o, --output string Change the output format. Use '--output=help' to know more details.
- -r, --raw Output raw data, without any formatting or coloring
- --server-url uri Manually specify the server to use

## Flags:
```bash

```

39 changes: 39 additions & 0 deletions mgc/cli/docs/lbaas/application_certificates/create/help.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
# Create TLS Certificate

## Usage:
```bash
Usage:
./mgc lbaas application-certificates create [load-balancer-id] [flags]
```

## Product catalog:
- Flags:
- --certificate string Certificate (required)
- --cli.list-links enum[=table] List all available links for this command (one of "json", "table" or "yaml")
- --description string Description
- -h, --help help for create
- --load-balancer-id string load_balancer_id: ID of the load balancer to create the certificate for (required)
- --name string The TLS Certificate unique name (required)
- --private-key string Private Key (required)
- -v, --version version for create

## Other commands:
- Global Flags:
- --api-key string Use your API key to authenticate with the API
- -U, --cli.retry-until string Retry the action with the same parameters until the given condition is met. The flag parameters
- use the format: 'retries,interval,condition', where 'retries' is a positive integer, 'interval' is
- a duration (ex: 2s) and 'condition' is a 'engine=value' pair such as "jsonpath=expression"
- -t, --cli.timeout duration If > 0, it's the timeout for the action execution. It's specified as numbers and unit suffix.
- Valid unit suffixes: ns, us, ms, s, m and h. Examples: 300ms, 1m30s
- --debug Display detailed log information at the debug level
- --env enum Environment to use (one of "pre-prod" or "prod") (default "prod")
- --no-confirm Bypasses confirmation step for commands that ask a confirmation from the user
- -o, --output string Change the output format. Use '--output=help' to know more details.
- -r, --raw Output raw data, without any formatting or coloring
- --server-url uri Manually specify the server to use

## Flags:
```bash

```

35 changes: 35 additions & 0 deletions mgc/cli/docs/lbaas/application_certificates/delete/help.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
# Delete TLS Certificate by ID

## Usage:
```bash
Usage:
./mgc lbaas application-certificates delete [load-balancer-id] [tls-certificate-id] [flags]
```

## Product catalog:
- Flags:
- -h, --help help for delete
- --load-balancer-id string load_balancer_id: ID of the load balancer to delete the certificate from (required)
- --tls-certificate-id string tls_certificate_id: ID of the TLS certificate to delete (required)
- -v, --version version for delete

## Other commands:
- Global Flags:
- --api-key string Use your API key to authenticate with the API
- -U, --cli.retry-until string Retry the action with the same parameters until the given condition is met. The flag parameters
- use the format: 'retries,interval,condition', where 'retries' is a positive integer, 'interval' is
- a duration (ex: 2s) and 'condition' is a 'engine=value' pair such as "jsonpath=expression"
- -t, --cli.timeout duration If > 0, it's the timeout for the action execution. It's specified as numbers and unit suffix.
- Valid unit suffixes: ns, us, ms, s, m and h. Examples: 300ms, 1m30s
- --debug Display detailed log information at the debug level
- --env enum Environment to use (one of "pre-prod" or "prod") (default "prod")
- --no-confirm Bypasses confirmation step for commands that ask a confirmation from the user
- -o, --output string Change the output format. Use '--output=help' to know more details.
- -r, --raw Output raw data, without any formatting or coloring
- --server-url uri Manually specify the server to use

## Flags:
```bash

```

36 changes: 36 additions & 0 deletions mgc/cli/docs/lbaas/application_certificates/get/help.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
# Get TLS Certificate by ID

## Usage:
```bash
Usage:
./mgc lbaas application-certificates get [load-balancer-id] [tls-certificate-id] [flags]
```

## Product catalog:
- Flags:
- --cli.list-links enum[=table] List all available links for this command (one of "json", "table" or "yaml")
- -h, --help help for get
- --load-balancer-id string load_balancer_id: ID of the load balancer to get the certificate from (required)
- --tls-certificate-id string tls_certificate_id: ID of the TLS certificate to fetch (required)
- -v, --version version for get

## Other commands:
- Global Flags:
- --api-key string Use your API key to authenticate with the API
- -U, --cli.retry-until string Retry the action with the same parameters until the given condition is met. The flag parameters
- use the format: 'retries,interval,condition', where 'retries' is a positive integer, 'interval' is
- a duration (ex: 2s) and 'condition' is a 'engine=value' pair such as "jsonpath=expression"
- -t, --cli.timeout duration If > 0, it's the timeout for the action execution. It's specified as numbers and unit suffix.
- Valid unit suffixes: ns, us, ms, s, m and h. Examples: 300ms, 1m30s
- --debug Display detailed log information at the debug level
- --env enum Environment to use (one of "pre-prod" or "prod") (default "prod")
- --no-confirm Bypasses confirmation step for commands that ask a confirmation from the user
- -o, --output string Change the output format. Use '--output=help' to know more details.
- -r, --raw Output raw data, without any formatting or coloring
- --server-url uri Manually specify the server to use

## Flags:
```bash

```

28 changes: 28 additions & 0 deletions mgc/cli/docs/lbaas/application_certificates/help.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# Application Load Balancer Tls Certificates

## Usage:
```bash
Usage:
./mgc lbaas application-certificates [flags]
./mgc lbaas application-certificates [command]
```

## Product catalog:
- Aliases:
- application-certificates, application_certificates

## Other commands:
- Commands:
- create Create TLS Certificate
- delete Delete TLS Certificate by ID
- get Get TLS Certificate by ID
- list List TLS Certificates
- replace Update TLS Certificate by ID

## Flags:
```bash
Flags:
-h, --help help for application-certificates
-v, --version version for application-certificates
```

Loading
Loading