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

vmware-variants: migrate host-container versions to latest versions #1898

Merged
merged 1 commit into from
Jan 19, 2022
Merged
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
3 changes: 3 additions & 0 deletions Release.toml
Original file line number Diff line number Diff line change
Expand Up @@ -90,3 +90,6 @@ version = "1.5.2"
"migrate_v1.5.1_control-container-v0-5-4.lz4",
]
"(1.5.1, 1.5.2)" = []
"(1.5.2, 1.6.0)" = [
"migrate_v1.6.0_vmware-host-containers.lz4",
]
8 changes: 8 additions & 0 deletions sources/Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions sources/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@ members = [
"api/migration/migrations/v1.5.0/oci-hooks-setting",
"api/migration/migrations/v1.5.0/oci-hooks-setting-metadata",
"api/migration/migrations/v1.5.1/control-container-v0-5-4",
"api/migration/migrations/v1.6.0/vmware-host-containers",

"bottlerocket-release",

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
[package]
name = "vmware-host-containers"
version = "0.1.0"
authors = ["Erikson Tung <[email protected]>"]
license = "Apache-2.0 OR MIT"
edition = "2021"
publish = false
# Don't rebuild crate just because of changes to README.
exclude = ["README.md"]

[dependencies]
serde_json = "1"
migration-helpers = { path = "../../../migration-helpers", version = "0.1.0"}
Original file line number Diff line number Diff line change
@@ -0,0 +1,111 @@
#![deny(rust_2018_idioms)]

use migration_helpers::{migrate, Migration, MigrationData, Result};
use std::process;

const ADMIN_CONTAINER_SOURCE_SETTING_NAME: &str = "settings.host-containers.admin.source";
const ADMIN_CONTAINER_IMAGE_REPOSITORY: &str = "public.ecr.aws/bottlerocket/bottlerocket-admin";
const PREVIOUS_ADMIN_CONTAINER_VERSIONS: &[&str] = &["v0.7.0", "v0.7.1", "v0.7.2"];
const TARGET_ADMIN_CONTAINER_VERSION: &str = "v0.7.3";

const CONTROL_CONTAINER_SOURCE_SETTING_NAME: &str = "settings.host-containers.control.source";
const CONTROL_CONTAINER_IMAGE_REPOSITORY: &str = "public.ecr.aws/bottlerocket/bottlerocket-control";
const PREVIOUS_CONTROL_CONTAINER_VERSIONS: &[&str] = &["v0.5.0", "v0.5.1", "v0.5.2", "v0.5.3"];
const TARGET_CONTROL_CONTAINER_VERSION: &str = "v0.5.4";

pub struct VmwareHostContainerVersions;

impl Migration for VmwareHostContainerVersions {
fn forward(&mut self, mut input: MigrationData) -> Result<MigrationData> {
// For admin container
if let Some(data) = input.data.get_mut(ADMIN_CONTAINER_SOURCE_SETTING_NAME) {
match data {
serde_json::Value::String(source) => {
for ver in PREVIOUS_ADMIN_CONTAINER_VERSIONS {
let prev_source = format!("{}:{}", ADMIN_CONTAINER_IMAGE_REPOSITORY, ver);
if *source == prev_source {
*source = format!(
"{}:{}",
ADMIN_CONTAINER_IMAGE_REPOSITORY, TARGET_ADMIN_CONTAINER_VERSION
);
println!(
"Changed value of '{}' from '{}' to '{}' on upgrade",
ADMIN_CONTAINER_SOURCE_SETTING_NAME, prev_source, source
);
break;
}
}
}
_ => {
println!(
"'{}' is set to non-string value '{}'",
ADMIN_CONTAINER_SOURCE_SETTING_NAME, data
);
}
}
} else {
println!(
"Found no '{}' to change on upgrade",
ADMIN_CONTAINER_SOURCE_SETTING_NAME
);
}

// For control container
if let Some(data) = input.data.get_mut(CONTROL_CONTAINER_SOURCE_SETTING_NAME) {
match data {
serde_json::Value::String(source) => {
for ver in PREVIOUS_CONTROL_CONTAINER_VERSIONS {
let prev_source = format!("{}:{}", CONTROL_CONTAINER_IMAGE_REPOSITORY, ver);
if *source == prev_source {
*source = format!(
"{}:{}",
CONTROL_CONTAINER_IMAGE_REPOSITORY,
TARGET_CONTROL_CONTAINER_VERSION
);
println!(
"Changed value of '{}' from '{}' to '{}' on upgrade",
CONTROL_CONTAINER_SOURCE_SETTING_NAME, prev_source, source
);
break;
}
}
}
_ => {
println!(
"'{}' is set to non-string value '{}'",
CONTROL_CONTAINER_SOURCE_SETTING_NAME, data
);
}
}
} else {
println!(
"Found no '{}' to change on upgrade",
CONTROL_CONTAINER_SOURCE_SETTING_NAME
);
}

Ok(input)
}

fn backward(&mut self, input: MigrationData) -> Result<MigrationData> {
// It's unclear what version of the host-containers we should downgrade to since it could
// be any of the older host-container versions.
// We can just stay on the latest host-container version since there are no breaking changes.
Comment on lines +91 to +93
Copy link
Contributor Author

@etungsten etungsten Jan 12, 2022

Choose a reason for hiding this comment

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

I want to open this up for discussion.
The alternative to this is to create separate migrations between all the older versions of bottlerocket with incremental host-container version bumps instead of just having a single migration that bumps all versions to latest. This is feasible with how we push updates and how migrations work. But I'm not sure what reasons we may have for doing that.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

One reason might be for the 'enter-admin-container' script introduced in control-container v0.5.4. Since the script depends on apicliet exec which is a feature introduced in Bottlerocket version 1.4.0. The script wouldn't work on hosts older than v1.4.0.

Copy link
Contributor

Choose a reason for hiding this comment

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

My vote: I think the bump from the existing version to the latest is fine. On downgrade, I would expect my host containers to go back to the version they were before the upgrade. If there is a specific reason for someone to use one of the incremental versions, that version could be supplied via setting.

Copy link
Contributor Author

@etungsten etungsten Jan 14, 2022

Choose a reason for hiding this comment

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

On downgrade, I would expect my host containers to go back to the version they were before the upgrade.

Unfortunately we can't definitively know what the previously-set host-container source is once we've migrated since it could be any of the older versions we migrated from. The only way to preserve that information is to have a chain of migrations, i.e. a migration between each Bottlerocket host version where we bumped the default host-container versions.

Copy link
Contributor

Choose a reason for hiding this comment

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

have a chain of migrations

This is probably the right thing to do.

Copy link
Member

Choose a reason for hiding this comment

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

Hm. I have mixed feelings about this. I think in the instance that folks are downgrading and want a specific version, they should set it via user-data. The version of the container they had before would be dependent on the version when the host was initially set up, not necessarily the version they are rolling back to.

println!("Vmware host-container versions migration has no work to do on downgrade");
Ok(input)
}
}

fn run() -> Result<()> {
migrate(VmwareHostContainerVersions)
}

// Returning a Result from main makes it print a Debug representation of the error, but with Snafu
// we have nice Display representations of the error, so we wrap "main" (run) and print any error.
// https://github.com/shepmaster/snafu/issues/110
fn main() {
if let Err(e) = run() {
eprintln!("{}", e);
process::exit(1);
}
}