Skip to content

Commit

Permalink
Generate docs
Browse files Browse the repository at this point in the history
  • Loading branch information
joaopalet committed Nov 17, 2023
1 parent 99f924e commit 17650ec
Show file tree
Hide file tree
Showing 35 changed files with 1,258 additions and 1 deletion.
10 changes: 9 additions & 1 deletion docs/stackit.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,14 @@ The root command of the STACKIT CLI
### Options

```
-h, --help help for stackit
-h, --help help for stackit
--project-id string Project ID
```

### SEE ALSO

* [stackit auth](./stackit_auth.md) - Provides authentication functionality
* [stackit config](./stackit_config.md) - CLI configuration options
* [stackit dns](./stackit_dns.md) - Provides functionality for DNS
* [stackit postgresql](./stackit_postgresql.md) - Provides functionality for PostgreSQL

32 changes: 32 additions & 0 deletions docs/stackit_auth.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
## stackit auth

Provides authentication functionality

### Synopsis

Provides authentication functionality

### Examples

```
$ stackit auth login
```

### Options

```
-h, --help help for auth
```

### Options inherited from parent commands

```
--project-id string Project ID
```

### SEE ALSO

* [stackit](./stackit.md) - The root command of the STACKIT CLI
* [stackit auth activate-service-account](./stackit_auth_activate-service-account.md) - Activate service account authentication
* [stackit auth login](./stackit_auth_login.md) - Login to the provider

40 changes: 40 additions & 0 deletions docs/stackit_auth_activate-service-account.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
## stackit auth activate-service-account

Activate service account authentication

### Synopsis

Activate authentication using service account credentials.
For more details on how to configure your service account, check the Authentication section on our documentation (LINK HERE README)

```
stackit auth activate-service-account [flags]
```

### Examples

```
$ stackit auth activate-service-account --service-account-key-path path/to/service_account_key.json --private-key-path path/to/private_key.pem
```

### Options

```
-h, --help help for activate-service-account
--jwks-custom-endpoint string Custom endpoint for the jwks API, which is used to get the json web key sets (jwks) to validate tokens when the service-account authentication is activated
--private-key-path string RSA private key path
--service-account-key-path string Service account key path
--service-account-token string Service account long-lived access token
--token-custom-endpoint string Custom endpoint for the token API, which is used to request access tokens when the service-account authentication is activated
```

### Options inherited from parent commands

```
--project-id string Project ID
```

### SEE ALSO

* [stackit auth](./stackit_auth.md) - Provides authentication functionality

34 changes: 34 additions & 0 deletions docs/stackit_auth_login.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
## stackit auth login

Login to the provider

### Synopsis

Login to the provider

```
stackit auth login [flags]
```

### Examples

```
$ stackit auth login
```

### Options

```
-h, --help help for login
```

### Options inherited from parent commands

```
--project-id string Project ID
```

### SEE ALSO

* [stackit auth](./stackit_auth.md) - Provides authentication functionality

35 changes: 35 additions & 0 deletions docs/stackit_config.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
## stackit config

CLI configuration options

### Synopsis

CLI configuration options

### Examples

```
$ stackit config set --project-id xxx
$ stackit config inspect
$ stackit config unset --project-id
```

### Options

```
-h, --help help for config
```

### Options inherited from parent commands

```
--project-id string Project ID
```

### SEE ALSO

* [stackit](./stackit.md) - The root command of the STACKIT CLI
* [stackit config inspect](./stackit_config_inspect.md) - Inspect the current CLI configuration values
* [stackit config set](./stackit_config_set.md) - Set CLI configuration options
* [stackit config unset](./stackit_config_unset.md) - Unset CLI configuration options

34 changes: 34 additions & 0 deletions docs/stackit_config_inspect.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
## stackit config inspect

Inspect the current CLI configuration values

### Synopsis

Inspect the current CLI configuration values

```
stackit config inspect [flags]
```

### Examples

```
$ stackit config inspect
```

### Options

```
-h, --help help for inspect
```

### Options inherited from parent commands

```
--project-id string Project ID
```

### SEE ALSO

* [stackit config](./stackit_config.md) - CLI configuration options

37 changes: 37 additions & 0 deletions docs/stackit_config_set.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
## stackit config set

Set CLI configuration options

### Synopsis

Set CLI configuration options

```
stackit config set [flags]
```

### Examples

```
$ stackit config set --project-id xxx
```

### Options

```
--dns-custom-endpoint string DNS custom endpoint
-h, --help help for set
--postgresql-custom-endpoint string PostgreSQL custom endpoint
--session-time-limit string Maximum time before authentication is required again. Can't be larger than 24h. Examples: 3h, 5h30m40s
```

### Options inherited from parent commands

```
--project-id string Project ID
```

### SEE ALSO

* [stackit config](./stackit_config.md) - CLI configuration options

31 changes: 31 additions & 0 deletions docs/stackit_config_unset.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
## stackit config unset

Unset CLI configuration options

### Synopsis

Unset CLI configuration options

```
stackit config unset [flags]
```

### Examples

```
$ stackit config unset --project-id
```

### Options

```
--dns-custom-endpoint DNS custom endpoint
-h, --help help for unset
--postgresql-custom-endpoint PostgreSQL custom endpoint
--project-id Project ID
```

### SEE ALSO

* [stackit config](./stackit_config.md) - CLI configuration options

35 changes: 35 additions & 0 deletions docs/stackit_dns.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
## stackit dns

Provides functionality for DNS

### Synopsis

Provides functionality for DNS

### Examples

```
$ stackit dns zone list --project-id xxx
$ stackit dns zone create --project-id xxx --name my-zone --dns-name my-zone.com
$ stackit dns record-set list --project-id xxx --zone-id xxx
$ stackit dns record-set create --project-id xxx --zone-id xxx --name my-zone --type A --record 1.2.3.4 --record 5.6.7.8
```

### Options

```
-h, --help help for dns
```

### Options inherited from parent commands

```
--project-id string Project ID
```

### SEE ALSO

* [stackit](./stackit.md) - The root command of the STACKIT CLI
* [stackit dns record-set](./stackit_dns_record-set.md) - Provides functionality for DNS record set
* [stackit dns zone](./stackit_dns_zone.md) - Provides functionality for DNS zone

36 changes: 36 additions & 0 deletions docs/stackit_dns_record-set.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
## stackit dns record-set

Provides functionality for DNS record set

### Synopsis

Provides functionality for DNS record set

### Examples

```
$ stackit dns record-set list --project-id xxx --zone-id xxx
$ stackit dns record-set create --project-id xxx --zone-id xxx --name my-zone --type A --record 1.2.3.4 --record 5.6.7.8
```

### Options

```
-h, --help help for record-set
```

### Options inherited from parent commands

```
--project-id string Project ID
```

### SEE ALSO

* [stackit dns](./stackit_dns.md) - Provides functionality for DNS
* [stackit dns record-set create](./stackit_dns_record-set_create.md) - Creates a DNS record set
* [stackit dns record-set delete](./stackit_dns_record-set_delete.md) - Delete a DNS record set
* [stackit dns record-set describe](./stackit_dns_record-set_describe.md) - Get details of a DNS record set
* [stackit dns record-set list](./stackit_dns_record-set_list.md) - List all DNS record sets
* [stackit dns record-set update](./stackit_dns_record-set_update.md) - Updates a DNS record set

40 changes: 40 additions & 0 deletions docs/stackit_dns_record-set_create.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
## stackit dns record-set create

Creates a DNS record set

### Synopsis

Creates a DNS record set

```
stackit dns record-set create [flags]
```

### Examples

```
$ stackit dns record-set create --project-id xxx --zone-id xxx --name my-zone --type A --record 1.2.3.4 --record 5.6.7.8
```

### Options

```
--comment string User comment
-h, --help help for create
--name string Name of the record, should be compliant with RFC1035, Section 2.3.4
--record strings Records belonging to the record set
--ttl int Time to live, if not provided defaults to the zone's default TTL
--type string Zone type, one of ["A" "AAAA" "SOA" "CNAME" "NS" "MX" "TXT" "SRV" "PTR" "ALIAS" "DNAME" "CAA"]
--zone-id string Zone ID
```

### Options inherited from parent commands

```
--project-id string Project ID
```

### SEE ALSO

* [stackit dns record-set](./stackit_dns_record-set.md) - Provides functionality for DNS record set

Loading

0 comments on commit 17650ec

Please sign in to comment.