idyl namespace - IDYL Docs

View and manage the Namespaces of an Account. A Namespace is the Account-owned organizational and authorization scope for Workspaces, Workloads, and other application resources. Every Account has a reserved ‘default’ Namespace that cannot be deleted. Namespace names are unique within their Account.

Usage

idyl namespace

Aliases

namespaces
ns

Commands

Command	Description
`idyl namespace create`	Create a new namespace
`idyl namespace delete`	Delete a namespace
`idyl namespace edit`	Edit a namespace
`idyl namespace get`	Get namespace details or list all namespaces
`idyl namespace show`	Show the entered namespace

Inherited flags

Flag	Description
`-a <string>, --account-id <string>`	Account ID to use, overriding the current context.
`-c <string>, --context <string>`	Use the named context for this command.
`--homedir <string>`	Override the configuration directory. Defaults to ~/.config/idyl.
`-n <string>, --namespace <string>`	Namespace to address, overriding the entered context.
`--network <string>`	Override the Network for this command.
`-p <string>, --profile <string>`	Override the access profile for this command.
`-s <string>, --subnet <string>`	Subnet to use for this command, overriding the current context.
`--workspace <string>`	Workspace within the namespace, overriding the entered context.

Examples

# List the namespaces of the account
idyl namespace list

# Create a namespace
idyl namespace create backend

# Get namespace details
idyl ns get backend

# Edit a namespace
idyl ns edit backend --set-description "Updated description"

# Delete a namespace
idyl namespace delete backend

Subcommand reference

`idyl namespace create`

Create a new namespace in your account. Namespace names must be lowercase alphanumeric with hyphens, between 1-63 characters.

Usage

idyl namespace create <name> [flags]

Flags

Flag	Description
`--description <string>`	Description of the namespace.
`-o <string>, --output <string>`	Output format: table, json, yaml. Default: `table`.

Examples

# Create a namespace
idyl namespace create my-namespace

# Create with description
idyl ns create my-namespace --description "Production environment"

`idyl namespace delete`

Delete a Namespace from an Account. Deletion is asynchronous. The platform accepts it, records the Namespace as terminating, drains its Workspaces and every Namespace-scoped resource in every zone, and finalizes on its own; once finalized the name no longer resolves and may be reused. While it is terminating the Namespace still reads, and creating or editing anything in it is refused. Deleting a Namespace that is already terminating is accepted again. —wait blocks until the Namespace is finalized and exits the way ‘idyl wait’ does: 0 finalized, 124 when —timeout passes first. Without it the command returns as soon as the deletion is accepted. The Account’s reserved ‘default’ Namespace cannot be deleted. You will be prompted for confirmation unless the —yes flag is provided.

Usage

idyl namespace delete <name> [flags]

Flags

Flag	Description
`--timeout <duration>`	Maximum time to block with —wait; 0s checks the current state once. Default: `5m0s`.
`--wait`	Block until the namespace is finalized, exiting the way ‘idyl wait’ does.
`-y, --yes`	Skip confirmation prompts.

Examples

# Delete a namespace (with confirmation)
idyl namespace delete backend

# Delete without confirmation
idyl ns delete backend --yes

# Delete and block until the namespace is finalized
idyl namespace delete backend --yes --wait --timeout 10m

`idyl namespace edit`

Edit a namespace’s settings.

Usage

idyl namespace edit <name> [flags]

Flags

Flag	Description
`-o <string>, --output <string>`	Output format: table, json, yaml. Default: `table`.
`--set-description <string>`	Set the namespace description.

Examples

# Update description
idyl namespace edit my-namespace --set-description "New description"

`idyl namespace get`

Get details of a Namespace, or list the Namespaces of the Account. With no arguments, lists the Account’s Namespaces. With a name argument, gets details of that Namespace.

Usage

idyl namespace get [name] [flags]

Aliases

list
ls

Flags

Flag	Description
`--limit <int>`	Maximum number of namespaces to list. Default: `20`.
`--offset <int>`	Number of namespaces to skip. Default: `0`.
`-o <string>, --output <string>`	Output format: table, json, yaml. Default: `table`.

Examples

# List the namespaces of the account
idyl namespace get

# Get namespace details
idyl namespace get backend

# Get in JSON format
idyl ns get backend -o json

`idyl namespace show`

Show details of the namespace the context has entered. Respects —namespace, —account-id, and —context.

Usage

idyl namespace show [flags]

Flags

Flag	Description
`-o <string>, --output <string>`	Output format: table, json, yaml. Default: `table`.

Examples

# Show the entered namespace
idyl namespace show

# Show a specific namespace
idyl namespace show -n backend

# Show it in JSON format
idyl ns show -o json

​Usage

​Aliases

​Commands

​Inherited flags

​Examples

​Subcommand reference

​idyl namespace create

​Usage

​Flags

​Examples

​idyl namespace delete

​Usage

​Flags

​Examples

​idyl namespace edit

​Usage

​Flags

​Examples

​idyl namespace get

​Usage

​Aliases

​Flags

​Examples

​idyl namespace show

​Usage

​Flags

​Examples

Usage

Aliases

Commands

Inherited flags

Examples

Subcommand reference

`idyl namespace create`

Usage

Flags

Examples

`idyl namespace delete`

Usage

Flags

Examples

`idyl namespace edit`

Usage

Flags

Examples

`idyl namespace get`

Usage

Aliases

Flags

Examples

`idyl namespace show`

Usage

Flags

Examples