Skip to content
Open
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
2 changes: 1 addition & 1 deletion content/en/docs/v1.2/applications/clickhouse.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ aliases:
<!--
Autogenerated content. Don't edit this file directly; edit sources instead.
metadata: https://github.com/cozystack/website/blob/main/content/en/docs/v1.2/applications/_include/clickhouse.md
source: https://github.com/cozystack/cozystack/blob/release-1.2/packages/apps/clickhouse/README.md
source: https://github.com/cozystack/cozystack/blob/main/packages/apps/clickhouse/README.md
-->


Expand Down
2 changes: 1 addition & 1 deletion content/en/docs/v1.2/applications/foundationdb.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ weight: 50
<!--
Autogenerated content. Don't edit this file directly; edit sources instead.
metadata: https://github.com/cozystack/website/blob/main/content/en/docs/v1.2/applications/_include/foundationdb.md
source: https://github.com/cozystack/cozystack/blob/release-1.2/packages/apps/foundationdb/README.md
source: https://github.com/cozystack/cozystack/blob/main/packages/apps/foundationdb/README.md
-->


Expand Down
2 changes: 1 addition & 1 deletion content/en/docs/v1.2/applications/harbor.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ weight: 50
<!--
Autogenerated content. Don't edit this file directly; edit sources instead.
metadata: https://github.com/cozystack/website/blob/main/content/en/docs/v1.2/applications/_include/harbor.md
source: https://github.com/cozystack/cozystack/blob/release-1.2/packages/apps/harbor/README.md
source: https://github.com/cozystack/cozystack/blob/main/packages/apps/harbor/README.md
-->


Expand Down
2 changes: 1 addition & 1 deletion content/en/docs/v1.2/applications/kafka.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ aliases:
<!--
Autogenerated content. Don't edit this file directly; edit sources instead.
metadata: https://github.com/cozystack/website/blob/main/content/en/docs/v1.2/applications/_include/kafka.md
source: https://github.com/cozystack/cozystack/blob/release-1.2/packages/apps/kafka/README.md
source: https://github.com/cozystack/cozystack/blob/main/packages/apps/kafka/README.md
-->


Expand Down
2 changes: 1 addition & 1 deletion content/en/docs/v1.2/applications/mariadb.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ aliases:
<!--
Autogenerated content. Don't edit this file directly; edit sources instead.
metadata: https://github.com/cozystack/website/blob/main/content/en/docs/v1.2/applications/_include/mariadb.md
source: https://github.com/cozystack/cozystack/blob/release-1.2/packages/apps/mariadb/README.md
source: https://github.com/cozystack/cozystack/blob/main/packages/apps/mariadb/README.md
-->


Expand Down
2 changes: 1 addition & 1 deletion content/en/docs/v1.2/applications/mongodb.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ aliases:
<!--
Autogenerated content. Don't edit this file directly; edit sources instead.
metadata: https://github.com/cozystack/website/blob/main/content/en/docs/v1.2/applications/_include/mongodb.md
source: https://github.com/cozystack/cozystack/blob/release-1.2/packages/apps/mongodb/README.md
source: https://github.com/cozystack/cozystack/blob/main/packages/apps/mongodb/README.md
-->


Expand Down
2 changes: 1 addition & 1 deletion content/en/docs/v1.2/applications/nats.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ aliases:
<!--
Autogenerated content. Don't edit this file directly; edit sources instead.
metadata: https://github.com/cozystack/website/blob/main/content/en/docs/v1.2/applications/_include/nats.md
source: https://github.com/cozystack/cozystack/blob/release-1.2/packages/apps/nats/README.md
source: https://github.com/cozystack/cozystack/blob/main/packages/apps/nats/README.md
-->


Expand Down
2 changes: 1 addition & 1 deletion content/en/docs/v1.2/applications/openbao.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ weight: 50
<!--
Autogenerated content. Don't edit this file directly; edit sources instead.
metadata: https://github.com/cozystack/website/blob/main/content/en/docs/v1.2/applications/_include/openbao.md
source: https://github.com/cozystack/cozystack/blob/release-1.2/packages/apps/openbao/README.md
source: https://github.com/cozystack/cozystack/blob/main/packages/apps/openbao/README.md
-->


Expand Down
2 changes: 1 addition & 1 deletion content/en/docs/v1.2/applications/postgres.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ aliases:
<!--
Autogenerated content. Don't edit this file directly; edit sources instead.
metadata: https://github.com/cozystack/website/blob/main/content/en/docs/v1.2/applications/_include/postgres.md
source: https://github.com/cozystack/cozystack/blob/release-1.2/packages/apps/postgres/README.md
source: https://github.com/cozystack/cozystack/blob/main/packages/apps/postgres/README.md
-->


Expand Down
2 changes: 1 addition & 1 deletion content/en/docs/v1.2/applications/qdrant.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ weight: 50
<!--
Autogenerated content. Don't edit this file directly; edit sources instead.
metadata: https://github.com/cozystack/website/blob/main/content/en/docs/v1.2/applications/_include/qdrant.md
source: https://github.com/cozystack/cozystack/blob/release-1.2/packages/apps/qdrant/README.md
source: https://github.com/cozystack/cozystack/blob/main/packages/apps/qdrant/README.md
-->


Expand Down
2 changes: 1 addition & 1 deletion content/en/docs/v1.2/applications/rabbitmq.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ aliases:
<!--
Autogenerated content. Don't edit this file directly; edit sources instead.
metadata: https://github.com/cozystack/website/blob/main/content/en/docs/v1.2/applications/_include/rabbitmq.md
source: https://github.com/cozystack/cozystack/blob/release-1.2/packages/apps/rabbitmq/README.md
source: https://github.com/cozystack/cozystack/blob/main/packages/apps/rabbitmq/README.md
-->


Expand Down
2 changes: 1 addition & 1 deletion content/en/docs/v1.2/applications/redis.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ aliases:
<!--
Autogenerated content. Don't edit this file directly; edit sources instead.
metadata: https://github.com/cozystack/website/blob/main/content/en/docs/v1.2/applications/_include/redis.md
source: https://github.com/cozystack/cozystack/blob/release-1.2/packages/apps/redis/README.md
source: https://github.com/cozystack/cozystack/blob/main/packages/apps/redis/README.md
-->


Expand Down
16 changes: 8 additions & 8 deletions content/en/docs/v1.2/applications/tenant.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ aliases:
<!--
Autogenerated content. Don't edit this file directly; edit sources instead.
metadata: https://github.com/cozystack/website/blob/main/content/en/docs/v1.2/applications/_include/tenant.md
source: https://github.com/cozystack/cozystack/blob/release-1.2/packages/apps/tenant/README.md
source: https://github.com/cozystack/cozystack/blob/main/packages/apps/tenant/README.md
-->


Expand All @@ -20,15 +20,15 @@ Tenants can be created recursively and are subject to the following rules:

### Tenant naming

Tenant names must follow DNS-1035 naming rules:
- Must start with a lowercase letter (`a-z`)
- Can only contain lowercase letters, numbers, and hyphens (`a-z`, `0-9`, `-`)
- Must end with a letter or number (not a hyphen)
Tenant names must be alphanumeric:

- Lowercase letters (`a-z`) and digits (`0-9`) only
- Must start with a lowercase letter
- Dashes (`-`) are **not allowed**, unlike with other services
- Maximum length depends on the cluster configuration (Helm release prefix and root domain)

**Note:** Using dashes (`-`) in tenant names is **allowed but discouraged**, unlike with other services.
This is to keep consistent naming in tenants, nested tenants, and services deployed in them.
Names with dashes (e.g., `foo-bar`) may lead to ambiguous parsing of internal resource names like `tenant-foo-bar`.
This restriction exists to keep consistent naming in tenants, nested tenants, and services deployed in them.
A tenant cannot be named `foo-bar` because parsing internal resource names like `tenant-foo-bar` would be ambiguous.

For example:

Expand Down
2 changes: 1 addition & 1 deletion content/en/docs/v1.2/kubernetes/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ aliases:
<!--
Autogenerated content. Don't edit this file directly; edit sources instead.
metadata: https://github.com/cozystack/website/blob/main/content/en/docs/v1.2/kubernetes/_include/_index.md
source: https://github.com/cozystack/cozystack/blob/release-1.2/packages/apps/kubernetes/README.md
source: https://github.com/cozystack/cozystack/blob/main/packages/apps/kubernetes/README.md
-->


Expand Down
2 changes: 1 addition & 1 deletion content/en/docs/v1.2/networking/http-cache.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ aliases:
<!--
Autogenerated content. Don't edit this file directly; edit sources instead.
metadata: https://github.com/cozystack/website/blob/main/content/en/docs/v1.2/networking/_include/http-cache.md
source: https://github.com/cozystack/cozystack/blob/release-1.2/packages/apps/http-cache/README.md
source: https://github.com/cozystack/cozystack/blob/main/packages/apps/http-cache/README.md
-->


Expand Down
2 changes: 1 addition & 1 deletion content/en/docs/v1.2/networking/tcp-balancer.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ aliases:
<!--
Autogenerated content. Don't edit this file directly; edit sources instead.
metadata: https://github.com/cozystack/website/blob/main/content/en/docs/v1.2/networking/_include/tcp-balancer.md
source: https://github.com/cozystack/cozystack/blob/release-1.2/packages/apps/tcp-balancer/README.md
source: https://github.com/cozystack/cozystack/blob/main/packages/apps/tcp-balancer/README.md
-->


Expand Down
2 changes: 1 addition & 1 deletion content/en/docs/v1.2/networking/vpc.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ aliases:
<!--
Autogenerated content. Don't edit this file directly; edit sources instead.
metadata: https://github.com/cozystack/website/blob/main/content/en/docs/v1.2/networking/_include/vpc.md
source: https://github.com/cozystack/cozystack/blob/release-1.2/packages/apps/vpc/README.md
source: https://github.com/cozystack/cozystack/blob/main/packages/apps/vpc/README.md
-->


Expand Down
2 changes: 1 addition & 1 deletion content/en/docs/v1.2/networking/vpn.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ aliases:
<!--
Autogenerated content. Don't edit this file directly; edit sources instead.
metadata: https://github.com/cozystack/website/blob/main/content/en/docs/v1.2/networking/_include/vpn.md
source: https://github.com/cozystack/cozystack/blob/release-1.2/packages/apps/vpn/README.md
source: https://github.com/cozystack/cozystack/blob/main/packages/apps/vpn/README.md
-->


Expand Down
2 changes: 1 addition & 1 deletion content/en/docs/v1.2/operations/services/bootbox.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ linkTitle: "BootBox"
<!--
Autogenerated content. Don't edit this file directly; edit sources instead.
metadata: https://github.com/cozystack/website/blob/main/content/en/docs/v1.2/operations/services/_include/bootbox.md
source: https://github.com/cozystack/cozystack/blob/release-1.2/packages/extra/bootbox/README.md
source: https://github.com/cozystack/cozystack/blob/main/packages/extra/bootbox/README.md
-->


Expand Down
2 changes: 1 addition & 1 deletion content/en/docs/v1.2/operations/services/etcd.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ linkTitle: "Etcd"
<!--
Autogenerated content. Don't edit this file directly; edit sources instead.
metadata: https://github.com/cozystack/website/blob/main/content/en/docs/v1.2/operations/services/_include/etcd.md
source: https://github.com/cozystack/cozystack/blob/release-1.2/packages/extra/etcd/README.md
source: https://github.com/cozystack/cozystack/blob/main/packages/extra/etcd/README.md
-->


Expand Down
2 changes: 1 addition & 1 deletion content/en/docs/v1.2/operations/services/ingress.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ linkTitle: "Ingress"
<!--
Autogenerated content. Don't edit this file directly; edit sources instead.
metadata: https://github.com/cozystack/website/blob/main/content/en/docs/v1.2/operations/services/_include/ingress.md
source: https://github.com/cozystack/cozystack/blob/release-1.2/packages/extra/ingress/README.md
source: https://github.com/cozystack/cozystack/blob/main/packages/extra/ingress/README.md
-->


Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ weight: 1
<!--
Autogenerated content. Don't edit this file directly; edit sources instead.
metadata: https://github.com/cozystack/website/blob/main/content/en/docs/v1.2/operations/services/_include/parameters.md
source: https://github.com/cozystack/cozystack/blob/release-1.2/packages/extra/monitoring/README.md
source: https://github.com/cozystack/cozystack/blob/main/packages/extra/monitoring/README.md
-->


Expand Down
2 changes: 1 addition & 1 deletion content/en/docs/v1.2/operations/services/seaweedfs.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ linkTitle: "SeaweedFS"
<!--
Autogenerated content. Don't edit this file directly; edit sources instead.
metadata: https://github.com/cozystack/website/blob/main/content/en/docs/v1.2/operations/services/_include/seaweedfs.md
source: https://github.com/cozystack/cozystack/blob/release-1.2/packages/extra/seaweedfs/README.md
source: https://github.com/cozystack/cozystack/blob/main/packages/extra/seaweedfs/README.md
-->


Expand Down
26 changes: 14 additions & 12 deletions content/en/docs/v1.2/virtualization/vm-disk.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ aliases:
<!--
Autogenerated content. Don't edit this file directly; edit sources instead.
metadata: https://github.com/cozystack/website/blob/main/content/en/docs/v1.2/virtualization/_include/vm-disk.md
source: https://github.com/cozystack/cozystack/blob/release-1.2/packages/apps/vm-disk/README.md
source: https://github.com/cozystack/cozystack/blob/main/packages/apps/vm-disk/README.md
-->


Expand All @@ -20,15 +20,17 @@ A Virtual Machine Disk

### Common parameters

| Name | Description | Type | Value |
| ------------------- | ------------------------------------------------------------------------------------------------------------------------ | ---------- | ------------ |
| `source` | The source image location used to create a disk. | `object` | `{}` |
| `source.image` | Use image by name. | `*object` | `null` |
| `source.image.name` | Name of the image to use (uploaded as "golden image" or from the list: `ubuntu`, `fedora`, `cirros`, `alpine`, `talos`). | `string` | `""` |
| `source.upload` | Upload local image. | `*object` | `null` |
| `source.http` | Download image from an HTTP source. | `*object` | `null` |
| `source.http.url` | URL to download the image. | `string` | `""` |
| `optical` | Defines if disk should be considered optical. | `bool` | `false` |
| `storage` | The size of the disk allocated for the virtual machine. | `quantity` | `5Gi` |
| `storageClass` | StorageClass used to store the data. | `string` | `replicated` |
| Name | Description | Type | Value |
| ------------------- | ------------------------------------------------------- | ---------- | ------------ |
| `source` | The source image location used to create a disk. | `object` | `{}` |
| `source.image` | Use image by name from default collection. | `*object` | `null` |
| `source.image.name` | Name of the image to use. | `string` | `""` |
| `source.upload` | Upload local image. | `*object` | `null` |
| `source.http` | Download image from an HTTP source. | `*object` | `null` |
| `source.http.url` | URL to download the image. | `string` | `""` |
| `source.disk` | Clone an existing vm-disk. | `*object` | `null` |
| `source.disk.name` | Name of the vm-disk to clone. | `string` | `""` |
| `optical` | Defines if disk should be considered optical. | `bool` | `false` |
| `storage` | The size of the disk allocated for the virtual machine. | `quantity` | `5Gi` |
| `storageClass` | StorageClass used to store the data. | `string` | `replicated` |

10 changes: 6 additions & 4 deletions content/en/docs/v1.2/virtualization/vm-instance.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ aliases:
<!--
Autogenerated content. Don't edit this file directly; edit sources instead.
metadata: https://github.com/cozystack/website/blob/main/content/en/docs/v1.2/virtualization/_include/vm-instance.md
source: https://github.com/cozystack/cozystack/blob/release-1.2/packages/apps/vm-instance/README.md
source: https://github.com/cozystack/cozystack/blob/main/packages/apps/vm-instance/README.md
-->


Expand Down Expand Up @@ -61,8 +61,10 @@ virtctl ssh <user>@<vm>
| `disks` | List of disks to attach. | `[]object` | `[]` |
| `disks[i].name` | Disk name. | `string` | `""` |
| `disks[i].bus` | Disk bus type (e.g. "sata"). | `string` | `""` |
| `subnets` | Additional subnets | `[]object` | `[]` |
| `subnets[i].name` | Subnet name | `string` | `""` |
| `networks` | Networks to attach the VM to. | `[]object` | `[]` |
| `networks[i].name` | Network attachment name. | `string` | `""` |
| `subnets` | Deprecated: use networks instead. | `[]object` | `[]` |
| `subnets[i].name` | Network attachment name. | `string` | `""` |
| `gpus` | List of GPUs to attach (NVIDIA driver requires at least 4 GiB RAM). | `[]object` | `[]` |
| `gpus[i].name` | The name of the GPU resource to attach. | `string` | `""` |
| `cpuModel` | Model specifies the CPU model inside the VMI. List of available models https://github.com/libvirt/libvirt/tree/master/src/cpu_map | `string` | `""` |
Expand Down Expand Up @@ -186,7 +188,7 @@ Specific characteristics of this series are:
## Development

To get started with customizing or creating your own instancetypes and preferences
see [Developer Guide]({{% ref "/docs/v1.2/development" %}}).
see [DEVELOPMENT.md](./DEVELOPMENT.md).

## Resources

Expand Down