|
2 | 2 | ## @section Common parameters |
3 | 3 |
|
4 | 4 | ## @param external {bool} Enable external access from outside the cluster |
5 | | -## @param size {string} Persistent Volume size |
6 | | -## @param replicas {int} Number of Postgres replicas |
7 | | -## @param storageClass {string} StorageClass used to store the data |
| 5 | +## @param externalMethod {string enum:"PortList,WholeIP"} Specify method to passthrough the traffic to the virtual machine. Allowed values: `WholeIP` and `PortList` |
| 6 | +## @param externalPorts {[]int} Specify ports to forward from outside the cluster |
8 | 7 | ## |
9 | 8 | external: false |
10 | | -size: 10Gi |
11 | | -replicas: 2 |
12 | | -storageClass: "" |
| 9 | +externalMethod: PortList |
| 10 | +externalPorts: |
| 11 | +- 22 |
13 | 12 |
|
14 | | -## @param postgresql {postgresql} PostgreSQL server configuration |
15 | | -## @field postgresql/parameters {postgresqlParameters} PostgreSQL server parameters |
16 | | -## @field postgresqlParameters/max_connections {int} Determines the maximum number of concurrent connections to the database server. The default is typically 100 connections |
| 13 | +## @param running {bool} if the virtual machine should be running |
| 14 | +running: true |
| 15 | + |
| 16 | +## @param instanceType {string} Virtual Machine instance type |
| 17 | +## @param instanceProfile {string} Virtual Machine preferences profile |
17 | 18 | ## |
18 | | -postgresql: |
19 | | - parameters: |
20 | | - max_connections: 100 |
| 19 | +instanceType: "u1.medium" |
| 20 | +instanceProfile: ubuntu |
21 | 21 |
|
22 | | -## Configuration for the quorum-based synchronous replication |
23 | | -## @param quorum {quorum} Quorum configuration for synchronous replication |
24 | | -## @field quorum/minSyncReplicas {int} Minimum number of synchronous replicas that must acknowledge a transaction before it is considered committed. |
25 | | -## @field quorum/maxSyncReplicas {int} Maximum number of synchronous replicas that can acknowledge a transaction (must be lower than the number of instances). |
26 | | -quorum: |
27 | | - minSyncReplicas: 0 |
28 | | - maxSyncReplicas: 0 |
| 22 | +## @param systemDisk {systemDisk} System disk configuration |
| 23 | +## @field systemDisk.image {string} The base image for the virtual machine. Allowed values: `ubuntu`, `cirros`, `alpine`, `fedora` and `talos` |
| 24 | +## @field systemDisk.storage {string} The size of the disk allocated for the virtual machine |
| 25 | +## @field systemDisk.storageClass {*string} StorageClass used to store the data |
| 26 | +## |
| 27 | +systemDisk: |
| 28 | + image: ubuntu |
| 29 | + storage: 5Gi |
| 30 | + storageClass: replicated |
29 | 31 |
|
30 | | -## @section Configuration parameters |
| 32 | +## @param gpus {[]gpu} List of GPUs to attach |
| 33 | +## @field gpu.name {string} The name of the GPU to attach. This should match the GPU resource name in the cluster. |
| 34 | +## Example: |
| 35 | +## gpus: |
| 36 | +## - name: nvidia.com/GA102GL_A10 |
| 37 | +gpus: [] |
31 | 38 |
|
32 | | -## @param users {map[string]user} Users configuration |
33 | | -## @field user/password {string} Password for the user |
34 | | -## @field user/replication {bool} Whether the user has replication privileges |
35 | | -## |
| 39 | +## @param resources.cpu The number of CPU cores allocated to the virtual machine |
| 40 | +## @param resources.memory The amount of memory allocated to the virtual machine |
| 41 | +## @param resources.sockets The number of CPU sockets allocated to the virtual machine (used to define vCPU topology) |
| 42 | +# |
| 43 | +## @param resources {resources} Resources |
| 44 | +## @field resources.cpu {quantity} CPU |
| 45 | +## @field resources.memory {quantity} Memory |
| 46 | +## @field resources.memory {string} Sockets |
| 47 | +resources: |
| 48 | + cpu: "" |
| 49 | + memory: "" |
| 50 | + sockets: "" |
| 51 | + |
| 52 | +## @param sshKeys {[]string} List of SSH public keys for authentication. Can be a single key or a list of keys. |
36 | 53 | ## Example: |
37 | | -## users: |
38 | | -## user1: |
39 | | -## password: strongpassword |
40 | | -## user2: |
41 | | -## password: hackme |
42 | | -## airflow: |
43 | | -## password: qwerty123 |
44 | | -## debezium: |
45 | | -## replication: true |
| 54 | +## sshKeys: |
| 55 | +## - ssh-rsa ... |
| 56 | +## - ssh-ed25519 ... |
46 | 57 | ## |
47 | | -users: {} |
| 58 | +sshKeys: [] |
48 | 59 |
|
49 | | -## @param databases {map[string]database} Databases configuration |
50 | | -## @field database/roles {databaseRoles} Roles for the database |
51 | | -## @field databaseRoles/admin {[]string} List of users with admin privileges |
52 | | -## @field databaseRoles/readonly {[]string} List of users with read-only privileges |
53 | | -## @field database/extensions {[]string} Extensions enabled for the database |
54 | | -## |
| 60 | +## @param cloudInit {string} cloud-init user data config. See cloud-init documentation for more details. |
| 61 | +## - https://cloudinit.readthedocs.io/en/latest/explanation/format.html |
| 62 | +## - https://cloudinit.readthedocs.io/en/latest/reference/examples.html |
55 | 63 | ## Example: |
56 | | -## databases: |
57 | | -## myapp: |
58 | | -## roles: |
59 | | -## admin: |
60 | | -## - user1 |
61 | | -## - debezium |
62 | | -## readonly: |
63 | | -## - user2 |
64 | | -## airflow: |
65 | | -## roles: |
66 | | -## admin: |
67 | | -## - airflow |
68 | | -## extensions: |
69 | | -## - hstore |
70 | | -databases: |
71 | | - asd: |
72 | | - roles: {} |
73 | | - assg: {} |
74 | | - |
75 | | -## @section Backup parameters |
76 | | - |
77 | | -## @param backup {backup} Backup configuration |
78 | | -## @field backup/enabled {bool} Enable regular backups |
79 | | -## @field backup/schedule {string} Cron schedule for automated backups |
80 | | -## @field backup/retentionPolicy {string} Retention policy |
81 | | -## @field backup/destinationPath {string} Path to store the backup (i.e. s3://bucket/path/to/folder) |
82 | | -## @field backup/endpointURL {string} S3 Endpoint used to upload data to the cloud |
83 | | -## @field backup/s3AccessKey {string} Access key for S3, used for authentication |
84 | | -## @field backup/s3SecretKey {string} Secret key for S3, used for authentication |
85 | | -backup: |
86 | | - enabled: false |
87 | | - retentionPolicy: 30d |
88 | | - destinationPath: s3://bucket/path/to/folder/ |
89 | | - endpointURL: http://minio-gateway-service:9000 |
90 | | - schedule: "0 2 * * * *" |
91 | | - s3AccessKey: oobaiRus9pah8PhohL1ThaeTa4UVa7gu |
92 | | - s3SecretKey: ju3eum4dekeich9ahM1te8waeGai0oog |
93 | | - |
94 | | -## @section Bootstrap parameters |
95 | | - |
96 | | -## @param bootstrap {bootstrap} Bootstrap configuration |
97 | | -## @field bootstrap/enabled {bool} Restore database cluster from a backup |
98 | | -## @field bootstrap/recoveryTime {string} Timestamp (PITR) up to which recovery will proceed, expressed in RFC 3339 format. If left empty, will restore latest |
99 | | -## @field bootstrap/oldName {string} Name of database cluster before deleting |
| 64 | +## cloudInit: | |
| 65 | +## #cloud-config |
| 66 | +## password: ubuntu |
| 67 | +## chpasswd: { expire: False } |
100 | 68 | ## |
101 | | -bootstrap: |
102 | | - enabled: false |
103 | | - # example: 2020-11-26 15:22:00.00000+00 |
104 | | - recoveryTime: "" |
105 | | - oldName: "" |
106 | | - |
107 | | -## @param resources {resources} Resources |
108 | | -## @field resources/cpu {*quantity} CPU |
109 | | -## @field resources/memory {*quantity} Memory |
110 | | -resources: {} |
111 | | - # resources: |
112 | | - # cpu: 4000m |
113 | | - # memory: 4Gi |
114 | | - |
115 | | -## @param resourcesPreset {string enum:"nano,micro,small,medium,large,xlarge,2xlarge"} Default sizing preset used when `resources` is omitted. |
116 | | -resourcesPreset: "micro" |
| 69 | +cloudInit: "" |
117 | 70 |
|
118 | | - |
119 | | -## @param gpus {[]gpu} List of GPUs to attach |
120 | | -## @field gpu/name {string} The name of the GPU to attach. This should match the GPU resource name in the cluster. |
| 71 | +## @param cloudInitSeed {string} A seed string to generate an SMBIOS UUID for the VM. |
| 72 | +## Change it to any new value to force a full cloud-init reconfiguration. Change it when you want to apply |
| 73 | +## to an existing VM settings that are usually written only once, like new SSH keys or new network configuration. |
| 74 | +## An empty value does nothing (and the existing UUID is not reverted). Please note that changing this value |
| 75 | +## does not trigger a VM restart. You must perform the restart separately. |
121 | 76 | ## Example: |
122 | | -## gpus: |
123 | | -## - name: nvidia.com/GA102GL_A10 |
124 | | -gpus: [] |
| 77 | +## cloudInitSeed: "upd1" |
| 78 | +cloudInitSeed: "" |
0 commit comments