-
Notifications
You must be signed in to change notification settings - Fork 2
valkey: add argument_specs, move the provider check out of the task #719
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
GeertJohan
wants to merge
1
commit into
metal-stack:master
Choose a base branch
from
GeertJohan:argument-specs/valkey
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,129 @@ | ||
| --- | ||
| argument_specs: | ||
| main: | ||
| short_description: Deploys a Valkey instance with the backup-restore-sidecar | ||
| options: | ||
| valkey_name: | ||
| type: str | ||
| description: Name of the valkey deployment. | ||
| valkey_namespace: | ||
| type: str | ||
| description: The namespace to deploy valkey to. | ||
| valkey_image_pull_policy: | ||
| type: str | ||
| description: Image pull policy for the valkey container. | ||
| valkey_storage_size: | ||
| type: str | ||
| description: Size of the persistent volume. | ||
| valkey_storage_class: | ||
| type: str | ||
| description: Storage class of the persistent volume. | ||
| valkey_backup_restore_sidecar_image_pull_policy: | ||
| type: str | ||
| description: Image pull policy for the backup-restore-sidecar container. | ||
| valkey_backup_restore_sidecar_provider: | ||
| type: str | ||
| choices: | ||
| - local | ||
| - gcp | ||
| - s3 | ||
| description: Backup provider used by the backup-restore-sidecar. | ||
| valkey_backup_restore_sidecar_backup_cron_schedule: | ||
| type: str | ||
| description: Cron schedule for creating backups. | ||
| valkey_backup_restore_sidecar_log_level: | ||
| type: str | ||
| description: Log level of the backup-restore-sidecar. | ||
| valkey_backup_restore_sidecar_gcp_bucket_name: | ||
| type: str | ||
| description: GCP bucket name for storing backups. | ||
| valkey_backup_restore_sidecar_gcp_backup_location: | ||
| type: str | ||
| description: GCP bucket location for storing backups. | ||
| valkey_backup_restore_sidecar_gcp_project_id: | ||
| type: str | ||
| description: GCP project id of the backup bucket. | ||
| valkey_backup_restore_sidecar_gcp_serviceaccount_json: | ||
| type: str | ||
| no_log: true | ||
| description: GCP service account JSON used for accessing the backup bucket. | ||
| valkey_backup_restore_sidecar_s3_bucket_name: | ||
| type: str | ||
| description: S3 bucket name for storing backups. | ||
| valkey_backup_restore_sidecar_s3_region: | ||
| type: str | ||
| description: S3 region of the backup bucket. | ||
| valkey_backup_restore_sidecar_s3_endpoint: | ||
| type: str | ||
| description: S3 endpoint of the backup bucket. | ||
| valkey_backup_restore_sidecar_s3_access_key: | ||
| type: str | ||
| description: S3 access key for the backup bucket. | ||
| valkey_backup_restore_sidecar_s3_secret_key: | ||
| type: str | ||
| no_log: true | ||
| description: S3 secret key for the backup bucket. | ||
| valkey_backup_restore_sidecar_s3_insecure_skip_verify: | ||
| type: bool | ||
| description: Whether to skip TLS certificate verification for the S3 endpoint. | ||
| valkey_backup_restore_sidecar_s3_trusted_ca_cert: | ||
| type: str | ||
| description: Trusted CA certificate for the S3 endpoint. | ||
| valkey_backup_restore_sidecar_object_max_keep: | ||
| type: int | ||
| description: Maximum amount of backup objects to keep. | ||
| valkey_backup_restore_sidecar_s3_object_days_max_keep: | ||
| type: int | ||
| description: Maximum amount of days to keep a backup object in the bucket. | ||
| valkey_backup_restore_sidecar_s3_request_checksum_calculation: | ||
| type: str | ||
| description: | ||
| - Controls the RequestChecksumCalculation setting of the S3 client. | ||
| - Either C(when_required) or C(when_supported). | ||
| - Not expressed as C(choices) because the default is unset and | ||
| choices would reject that. | ||
| valkey_backup_restore_sidecar_encryption_key: | ||
| type: str | ||
| no_log: true | ||
| description: Encryption key (32 characters) for encrypting backups. | ||
| valkey_resources: | ||
| type: dict | ||
| description: Resource requests and limits for the valkey container. | ||
| valkey_backup_restore_sidecar_resources: | ||
| type: dict | ||
| description: Resource requests and limits for the backup-restore-sidecar container. | ||
| valkey_init_resources: | ||
| type: dict | ||
| description: Resource requests and limits for the init container. | ||
| valkey_registry_auth_enabled: | ||
| type: bool | ||
| description: Whether to deploy an image pull secret for the registry. | ||
|
Comment on lines
+98
to
+100
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Must be a bool |
||
| valkey_registry_auth: | ||
| type: dict | ||
| no_log: true | ||
| description: Docker auth configuration for the image pull secret. | ||
| valkey_enable_security_context: | ||
| type: bool | ||
| description: Whether to render the pod and container security contexts. | ||
| valkey_sts_security_context: | ||
| type: dict | ||
| description: Pod security context for the statefulset. | ||
| valkey_container_security_context: | ||
| type: dict | ||
| description: Security context for the containers. | ||
| # The image variables below are resolved from the metal-stack release | ||
| # vector by the setup_yaml task at the start of this role. Role argument | ||
| # validation runs BEFORE that task, so they cannot be marked required | ||
| # here - the assert in tasks/main.yaml keeps checking them. | ||
| valkey_image_name: | ||
| type: str | ||
| description: Image name of valkey. | ||
| valkey_image_tag: | ||
| type: str | ||
| description: Image tag of valkey. | ||
| valkey_backup_restore_sidecar_image_name: | ||
| type: str | ||
| description: Image name of the backup-restore-sidecar. | ||
| valkey_backup_restore_sidecar_image_tag: | ||
| type: str | ||
| description: Image tag of the backup-restore-sidecar. | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do we want to add
optionshere and / or in other places?Of course we don't have to mirror k8s here and especially not all levels deep, but it might make sense in some cases to at least provide top-level attributes. The resources aren't necessarily a good example of this. Might be handy for upcoming PRs though :)
e.g.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
For certain variables this would be quite useful. As long as it does not prevent some degree of freedom, which might already be used by some consumers.