Skip to content
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

Remove host container migration #4324

Open
wants to merge 12 commits into
base: develop
Choose a base branch
from

Conversation

vyaghras
Copy link
Contributor

@vyaghras vyaghras commented Dec 6, 2024

Issue number:

Closes #

Description of changes:

migrations: remove all the weak setting on downgrade 
migrations: Change public control host-container source metadata to object 
migrations: Change aws admin host-container source metadata to object 
migrations: Change public control host-container source metadata to object 
migrations: Change public admin host-container source metadata to object 
common_migrations: add new migrations to handle settings-generator as struct 
models: Add Strength enum and Setting-Generator struct 
apiclient: update README to document version 2 of /tx API 
shared-defaults: change public host container source setting-generator to table 
shared-defaults: change aws host container source setting-generator to table 
datastore: changes to match changes in Core kit datastore

Testing done:
Refer to testing in bottlerocket-os/bottlerocket-core-kit#294

Terms of contribution:

By submitting this pull request, I agree that this contribution is dual-licensed under the terms of both the Apache License, version 2.0, and the MIT license.

@vyaghras vyaghras force-pushed the remove_host_container_migration branch from f3531f7 to b77efc3 Compare December 6, 2024 19:02
@vyaghras
Copy link
Contributor Author

vyaghras commented Dec 6, 2024

☝️ Changed the Version in Twoliter.toml

@vyaghras vyaghras requested review from bcressey and cbgbt December 6, 2024 20:57
@vyaghras vyaghras mentioned this pull request Jan 2, 2025
7 tasks
Comment on lines 6 to 13
[settings.host-containers.admin]
enabled = false
superpowered = true
source = "public.ecr.aws/bottlerocket/bottlerocket-admin:v0.11.14"

[metadata.settings.host-containers.admin.source.setting-generator]
command = "schnauzer-v2 render --template 'public.ecr.aws/bottlerocket/bottlerocket-admin:v0.11.14'"
strength = "weak"
skip-if-populated = true
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since these are static strings and don't require templates, can we disregard the setting generator and accomplish the same thing like this?

Suggested change
[settings.host-containers.admin]
enabled = false
superpowered = true
source = "public.ecr.aws/bottlerocket/bottlerocket-admin:v0.11.14"
[metadata.settings.host-containers.admin.source.setting-generator]
command = "schnauzer-v2 render --template 'public.ecr.aws/bottlerocket/bottlerocket-admin:v0.11.14'"
strength = "weak"
skip-if-populated = true
[settings.host-containers.admin]
enabled = false
superpowered = true
source = "public.ecr.aws/bottlerocket/bottlerocket-admin:v0.11.14"
[metadata.settings.host-containers.admin.source]
strength = "weak"

Comment on lines 18 to 22

[metadata.settings.host-containers.control.source.setting-generator]
command = "schnauzer-v2 render --template 'public.ecr.aws/bottlerocket/bottlerocket-control:v0.7.18'"
strength = "weak"
skip-if-populated = true
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same feedback as the admin container source for public ECR.

Comment on lines 1267 to 1041
pub struct MetadataStringToStructMigration {
pub setting: &'static str,
pub old_cmdline: &'static str,
pub new_cmdline: &'static str,
pub metadata_type: &'static str,
pub binary_for_generator: &'static str,
pub skip_if_populated: bool,
}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This seems highly specific to setting-generators, I doubt we'd use it elsewhere. I'd suggest renaming it to be more specific and dropping metadata_type as an argument.

We're already using Shlex ("shell lexer") in this migrator. Do we need binary_for_generator if we can just parse it out? The binary should always be the first element of the lexed command line.

Finally, I wonder if the settings for the "new" generator should just be a SettingsGenerator struct?

@vyaghras vyaghras force-pushed the remove_host_container_migration branch from b77efc3 to 95c4bac Compare January 22, 2025 00:39
This migration will change the public control host-container source to
new source.

In backward migration, it will be NO-Op.
This migration will change the public control host-container source
to new source.

In backward migration, it will be NO-Op as other migration will delete
the weak settings and all metadata on downgrade.
This migration will change the aws admin host-container source
setting-generator from string to object setting-generator metadata
(that will generate source using sundog) on forward migration.
We will also add a strength file with value "weak".

In backward migration, it will reset the value of the source setting
generator as string and delete the strength metadata.
This migration will change the aws control host-container source
setting-generator from string to object setting-generator metadata
(that will generate source using sundog) on forward migration.
We will also add a strength file with value "weak".

In backward migration, it will reset the value of the source setting
generator as string and delete the strength metadata.
We need this migration that will delete all the weak settings
and setting-generators.
We rely that metadata is always populated from defaults, and storewolf
will repopulate the metadata that is already not present in datastore.
…r to table

Update the source from string like:
public.ecr.aws/bottlerocket/bottlerocket-admin:v0.11.14

To setting generator as object, that contains:
- command
- strength
- skip-if-populated
…o table

Update the source from string like:
schnauzer-v2 render --requires 'aws@v1(helpers=[ecr-prefix])' --template
'{{ ecr-prefix settings.aws.region }}/bottlerocket-admin:v0.11.14'

To setting generator as object, that contains:
- command
- strength
- skip-if-populated
Updated the `commit_transaction` function to enable committing metadata
from pending transactions. In commit transaction we will first commit
metadata and then pending keys to correctly perform the check to
identify
if key exists or not.

The strength handling among pending and committed transaction is as:
If pending metadata is strong and committed metadata is weak, commit the
pending setting.

If pending metadata is weak, committed metadata is strong and
the setting is already available, do not downgrade from strong to weak.
Otherwise add the strength file with value as weak.

If pending and committed metadata are the same, no action is performed.

Additionally, made minor changes to metadata functions for improved
access and flexibility:
Introduced a `committed` field to dynamically access metadata in pending
transactions.
Replaced the hardcoded use of live committed metadata with this
committed variable ans pass Committed::Live from previous usages.

Refer commit:
bottlerocket-os/bottlerocket-core-kit@20a435e
Refer PR:
bottlerocket-os/bottlerocket-core-kit#294
@vyaghras vyaghras force-pushed the remove_host_container_migration branch from 95c4bac to 88c1fe4 Compare January 22, 2025 18:56
… struct

- RemoveWeakSettingsMigration: When we downgrade multiple version to a
  version where migrator is not aware of deleting the setting-generator
 as struct or the strength file. This migration will help us to delete
the strength and setting generator metadata.

- MetadataStringToStructMigration: migration to change host-containers
  source  metadata to struct from string.

- ReplaceSettingWithSettingGeneratorMigration: Migration to replace
  a setting with setting generator.

- ResetMetadataMigration: Migration to remove all metadata on upgrade
  and downgrade. This metadata will be rewritten by storewolf.

This migration will be used to convert a strong setting to a weak
setting.

Also deleted the test test_replaces_nothing for
ReplaceSchnauzerMigration because we are deleting all the metadata as
first step of the migrator, hence we will not have any metadata
available in existing datastore to compare. We will assume that the
settings generator in input metadata is same as Old schanuzer string and
will always replace that with incoming setting generator string.
@vyaghras vyaghras force-pushed the remove_host_container_migration branch from 88c1fe4 to 3e850ca Compare January 22, 2025 19:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants