groups: - name: Restic REST Server Configuration description: Configure Restic REST Server - name: User and Group Configuration description: Configure User and Group for Restic REST Server - name: Network Configuration description: Configure Network for Restic REST Server - name: Storage Configuration description: Configure Storage for Restic REST Server - name: Labels Configuration description: Configure Labels for Restic REST Server - name: Resources Configuration description: Configure Resources for Restic REST Server questions: - variable: TZ group: Restic REST Server Configuration label: Timezone schema: type: string default: Etc/UTC required: true $ref: - definitions/timezone - variable: rest_server label: "" group: Restic REST Server Configuration schema: type: dict attrs: - variable: append_only label: Append Only group: Restic REST Server Configuration description: | Enable append-only mode. In this mode, no existing snapshots can be deleted or modified. schema: type: boolean default: false - variable: group_accessible_repos label: Group Accessible Repositories group: Restic REST Server Configuration description: | Enable group accessible repositories. In this mode, repositories can be accessed by users in the same group. schema: type: boolean default: false - variable: private_repos label: Private Repositories group: Restic REST Server Configuration description: | Enable private repositories. In this mode, repositories can only be accessed by authenticated users. schema: type: boolean default: false - variable: no_auth label: No Authentication group: Restic REST Server Configuration description: | Disable authentication. In this mode, no authentication is required to access the repositories. schema: type: boolean default: false - variable: proxy_auth_username label: Proxy Authentication Username group: Restic REST Server Configuration description: | Specifies the HTTP header containing the username for proxy-based authentication schema: type: string show_if: [["no_auth", "=", false]] default: "" - variable: users label: Basic Auth Users description: The list of basic auth users. schema: type: list show_if: [["no_auth", "=", false]] default: [] items: - variable: user_entry label: User Entry schema: type: dict attrs: - variable: username label: Username schema: type: string required: true - variable: password label: Password schema: type: string required: true private: true - variable: extra_options label: Extra Options group: Restic REST Server Configuration description: | Additional options to pass to the Restic REST Server. Example: --some-option=value schema: type: list default: [] items: - variable: option label: Option schema: type: string required: true - variable: additional_envs label: Additional Environment Variables description: Configure additional environment variables for Restic REST Server. schema: type: list default: [] items: - variable: env label: Environment Variable schema: type: dict attrs: - variable: name label: Name schema: type: string required: true - variable: value label: Value schema: type: string - variable: run_as label: "" group: User and Group Configuration schema: type: dict attrs: - variable: user label: User ID description: The user id that Restic REST Server files will be owned by. schema: type: int min: 568 default: 568 required: true - variable: group label: Group ID description: The group id that Restic REST Server files will be owned by. schema: type: int min: 568 default: 568 required: true - variable: network label: "" group: Network Configuration schema: type: dict attrs: - variable: web_port label: WebUI Port schema: type: dict attrs: - variable: bind_mode label: Port Bind Mode description: | The port bind mode.
- Publish: The port will be published on the host for external access.
- Expose: The port will be exposed for inter-container communication.
- None: The port will not be exposed or published.
Note: If the Dockerfile defines an EXPOSE directive, the port will still be exposed for inter-container communication regardless of this setting. schema: type: string default: "published" enum: - value: "published" description: Publish port on the host for external access - value: "exposed" description: Expose port for inter-container communication - value: "" description: None - variable: port_number label: Port Number schema: type: int default: 30248 min: 1 max: 65535 required: true - variable: host_ips label: Host IPs description: IPs on the host to bind this port schema: type: list show_if: [["bind_mode", "=", "published"]] default: [] items: - variable: host_ip label: Host IP schema: type: string required: true $ref: - definitions/node_bind_ip - variable: host_network label: Host Network description: | Bind to the host network. It's recommended to keep this disabled. schema: type: boolean default: false - variable: certificate_id label: Certificate description: The certificate to use for Restic REST Servers. schema: type: int "null": true $ref: - "definitions/certificate" - variable: storage label: "" group: Storage Configuration schema: type: dict attrs: - variable: data label: Data Storage schema: type: dict attrs: - variable: type label: Type description: | ixVolume: Is dataset created automatically by the system.
Host Path: Is a path that already exists on the system. schema: type: string required: true default: "ix_volume" enum: - value: "host_path" description: Host Path (Path that already exists on the system) - value: "ix_volume" description: ixVolume (Dataset created automatically by the system) - variable: ix_volume_config label: ixVolume Configuration description: The configuration for the ixVolume dataset. schema: type: dict show_if: [["type", "=", "ix_volume"]] $ref: - "normalize/ix_volume" attrs: - variable: acl_enable label: Enable ACL description: Enable ACL for the storage. schema: type: boolean default: false - variable: dataset_name label: Dataset Name description: The name of the dataset to use for storage. schema: type: string required: true hidden: true default: "data" - variable: acl_entries label: ACL Configuration schema: type: dict show_if: [["acl_enable", "=", true]] attrs: [] - variable: host_path_config label: Host Path Configuration schema: type: dict show_if: [["type", "=", "host_path"]] attrs: - variable: acl_enable label: Enable ACL description: Enable ACL for the storage. schema: type: boolean default: false - variable: acl label: ACL Configuration schema: type: dict show_if: [["acl_enable", "=", true]] attrs: [] $ref: - "normalize/acl" - variable: path label: Host Path description: The host path to use for storage. schema: type: hostpath show_if: [["acl_enable", "=", false]] required: true - variable: additional_storage label: Additional Storage schema: type: list default: [] items: - variable: storageEntry label: Storage Entry schema: type: dict attrs: - variable: type label: Type description: | ixVolume: Is dataset created automatically by the system.
Host Path: Is a path that already exists on the system.
schema: type: string required: true default: "ix_volume" enum: - value: "host_path" description: Host Path (Path that already exists on the system) - value: "ix_volume" description: ixVolume (Dataset created automatically by the system) - variable: read_only label: Read Only description: Mount the volume as read only. schema: type: boolean default: false - variable: mount_path label: Mount Path description: The path inside the container to mount the storage. schema: type: path required: true - variable: host_path_config label: Host Path Configuration schema: type: dict show_if: [["type", "=", "host_path"]] attrs: - variable: acl_enable label: Enable ACL description: Enable ACL for the storage. schema: type: boolean default: false - variable: acl label: ACL Configuration schema: type: dict show_if: [["acl_enable", "=", true]] attrs: [] $ref: - "normalize/acl" - variable: path label: Host Path description: The host path to use for storage. schema: type: hostpath show_if: [["acl_enable", "=", false]] required: true - variable: ix_volume_config label: ixVolume Configuration description: The configuration for the ixVolume dataset. schema: type: dict show_if: [["type", "=", "ix_volume"]] $ref: - "normalize/ix_volume" attrs: - variable: acl_enable label: Enable ACL description: Enable ACL for the storage. schema: type: boolean default: false - variable: dataset_name label: Dataset Name description: The name of the dataset to use for storage. schema: type: string required: true default: "storage_entry" - variable: acl_entries label: ACL Configuration schema: type: dict show_if: [["acl_enable", "=", true]] attrs: [] - variable: labels label: "" group: Labels Configuration schema: type: list default: [] items: - variable: label label: Label schema: type: dict attrs: - variable: key label: Key schema: type: string required: true - variable: value label: Value schema: type: string required: true - variable: containers label: Containers description: Containers where the label should be applied schema: type: list items: - variable: container label: Container schema: type: string required: true enum: - value: restic-server description: restic-server - variable: resources label: "" group: Resources Configuration schema: type: dict attrs: - variable: limits label: Limits schema: type: dict attrs: - variable: cpus label: CPUs description: CPUs limit for Restic REST Server. schema: type: int default: 2 required: true - variable: memory label: Memory (in MB) description: Memory limit for Restic REST Server. schema: type: int default: 4096 required: true