kyvernon tenants

`kyvernon tenants`

Self-service tenants: quota, lifecycle, users, usage

Usage

kyvernon tenants <COMMAND>

Subcommands: list, get, create, quota, suspend, resume, close, usage, users

`kyvernon tenants list`

List tenants

Usage

kyvernon tenants list

API operation: GET /v1/tenants

`kyvernon tenants get`

Show a tenant with its quota and use

Usage

kyvernon tenants get <TENANT>

Argument	Description	Required
`<TENANT>`	Tenant id (`tenant-N`)	yes

API operation: GET /v1/tenants/{tenant}

`kyvernon tenants create`

Create a tenant (folders and pools are made for it)

Usage

kyvernon tenants create [OPTIONS] <NAME>

Argument	Description	Required
`<NAME>`	Short name (`[a-z0-9-]`)	yes
`--display-name`	Display name
`--external-ref`	The portal's account id
`--quota`	Quota as JSON (`{"vms": 5, "vcpus": 16}`)

API operation: POST /v1/tenants

`kyvernon tenants quota`

Replace the quota (JSON body: {"vcpus": 8, "memoryMib": 16384, ...}; null = unlimited)

Usage

kyvernon tenants quota [OPTIONS] <TENANT>

Argument	Description	Required
`<TENANT>`	Tenant id	yes
`--body`	Inline JSON body
`--body-file`	File with the JSON body (`-` for stdin)

API operation: PUT /v1/tenants/{tenant}/quota

`kyvernon tenants suspend`

Suspend a tenant (VMs shut down, users read-only)

Usage

kyvernon tenants suspend <TENANT>

Argument	Description	Required
`<TENANT>`	Tenant id	yes

API operation: POST /v1/tenants/{tenant}/suspend

`kyvernon tenants resume`

Resume a suspended tenant

Usage

kyvernon tenants resume <TENANT>

Argument	Description	Required
`<TENANT>`	Tenant id	yes

API operation: POST /v1/tenants/{tenant}/resume

`kyvernon tenants close`

Close a tenant (VMs destroyed after the grace period)

Usage

kyvernon tenants close [OPTIONS] <TENANT>

Argument	Description	Required
`<TENANT>`	Tenant id	yes
`--grace-seconds`	Seconds until destruction (default: the controller's grace)

API operation: POST /v1/tenants/{tenant}/close

`kyvernon tenants usage`

Usage of a month (plan hours, snapshot GiB-hours, traffic)

Usage

kyvernon tenants usage [OPTIONS] <TENANT>

Argument	Description	Required
`<TENANT>`	Tenant id	yes
`--month`	`YYYY-MM` (default: current month)

API operation: GET /v1/tenants/{tenant}/usage

`kyvernon tenants users`

Accounts of a tenant

Usage

kyvernon tenants users <TENANT> <COMMAND>

Argument	Description	Required
`<TENANT>`	Tenant id	yes

API operation: GET /v1/tenants/{tenant}/users

Subcommands: list, create, delete, api-tokens

`kyvernon tenants users list`

List accounts

Usage

kyvernon tenants users list

`kyvernon tenants users create`

Create an account (password from KYVERNON_PASSWORD or stdin)

Usage

kyvernon tenants users create [OPTIONS] <USERNAME>

Argument	Description	Required
`<USERNAME>`	Login name	yes
`--role`	`admin`, `user` or `read-only` default `user`
`--display-name`	Display name
`--email`	E-mail
`--service-account`	Automation account (API logins only)

`kyvernon tenants users delete`

Delete an account

Usage

kyvernon tenants users delete <USERNAME>

Argument	Description	Required
`<USERNAME>`	Login name	yes

`kyvernon tenants users api-tokens`

API tokens of an account

Usage

kyvernon tenants users api-tokens <USERNAME> <COMMAND>

Argument	Description	Required
`<USERNAME>`	Login name	yes

Subcommands: list, create, delete

`kyvernon tenants users api-tokens list`

List tokens

Usage

kyvernon tenants users api-tokens list

`kyvernon tenants users api-tokens create`

Create a token (shown once)

Usage

kyvernon tenants users api-tokens create [OPTIONS] <NAME>

Argument	Description	Required
`<NAME>`	Label	yes
`--ttl-seconds`	Lifetime in seconds

`kyvernon tenants users api-tokens delete`

Revoke a token

Usage

kyvernon tenants users api-tokens delete <ID>

Argument	Description	Required
`<ID>`	Token id	yes