Skip to content
This repository has been archived by the owner on May 12, 2021. It is now read-only.

docs: Add upgrading doc #79

Merged
merged 1 commit into from
May 17, 2018

Conversation

jodh-intel
Copy link
Contributor

Add a document explaining how to upgrade a system:

  • Running Clear Containers.
  • Already installed with Kata Containers binaries.

Fixes #78.

Signed-off-by: James O. D. Hunt james.o.hunt@intel.com

@jodh-intel jodh-intel force-pushed the add-upgrade-doc branch 5 times, most recently from 708d699 to 0752592 Compare May 15, 2018 11:41
@jodh-intel
Copy link
Contributor Author

@egernst, @jcvenegas, @klynnrif - ptal.

@bergwolf, @gnawux, @laijs - As the summary shows, this is (mostly) Clear Containers specific. I am happy to add runv details if you can supply me with details ;) Alternatively, do you want to add those details in a follow-up PR?

@bergwolf
Copy link
Member

There is simply no such thing as upgrading from runv. kata is a fresh installation and it can even run together with runv without affecting each other.

@jodh-intel
Copy link
Contributor Author

Hi @bergwolf - I thought that would be the case. Are you happy for this doc to land and then potentially for someone to raise a follow-on PR to update this doc explaining the runv approach?

@bergwolf
Copy link
Member

@jodh-intel yes, that's fine with me. I'll raise a PR to add the runv approach after this is landed.

@jodh-intel
Copy link
Contributor Author

Great - thanks @bergwolf.

@jcvenegas
Copy link
Member

@jodh-intel looks good - I'll be giving a try today to make sure it works in my clear-containers dev machine.

@egernst
Copy link
Member

egernst commented May 15, 2018

Assuming someone (@jcvenegas ) tests/verifies, the text and plan looks great to me.

Copy link

@klynnrif klynnrif left a comment

Choose a reason for hiding this comment

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

Scrubbed for grammar, structure, and flow. Thanks!

Upgrading.md Outdated

> **Warning**: If you have modified your
> [Clear Containers configuration](https://github.com/clearcontainers/runtime#configuration),
> you may wish to make a safe copy of the configuration file before removing the

Choose a reason for hiding this comment

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

you might want to make a safe copy...

Upgrading.md Outdated

Kata Containers requires additional resources to create a virtual machine
container. These resources are called
[Kata Containers assets](https://github.com/kata-containers/documentation/blob/master/architecture.md#assets)

Choose a reason for hiding this comment

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

Add in a comma after "Kata Containers assets"

Upgrading.md Outdated
Since the official assets are packaged, they are automatically upgraded when
new package versions are published.

> **Warning**: Note that if you are using custom assets (by modifying the

Choose a reason for hiding this comment

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

Warning: Note that if you use custom assets (by modifying the

Upgrading.md Outdated
The `kata-linux-container` package contains a Linux\* kernel based on the
latest vanilla version of the
[longterm kernel](https://www.kernel.org/)
and including a small number of

Choose a reason for hiding this comment

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

Should this be "and include"?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I couldn't find a good way to write this using "include", so I've changed it to "plus" ;)

Upgrading.md Outdated

The `Longterm` branch is only updated with
[important bug fixes](https://www.kernel.org/category/releases.html)
meaning this package will only be updated when necessary.

Choose a reason for hiding this comment

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

meaning this package is only updated when necessary.

Upgrading.md Outdated
[important bug fixes](https://www.kernel.org/category/releases.html)
meaning this package will only be updated when necessary.

The guest kernel package will be updated when a new longerm kernel is released

Choose a reason for hiding this comment

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

Rewrite + missing "t" in "longterm": The guest kernel package is updated when a new longterm kernel is released

Add a document explaining how to upgrade a system:

- Running Clear Containers.
- Already installed with Kata Containers binaries.

Also, include details of assets and how and when the are updated.

Fixes kata-containers#69, fixes kata-containers#78.

Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
@jodh-intel
Copy link
Contributor Author

Thanks @klynnrif - branch updated.

@egernst
Copy link
Member

egernst commented May 17, 2018

I'm happy to see it merged -- @klynnrif can you take a look please?

@jodh-intel jodh-intel added the release-gating Release must wait for this to be resolved before release label May 17, 2018
Copy link

@klynnrif klynnrif left a comment

Choose a reason for hiding this comment

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

lgtm - thanks!

@jodh-intel jodh-intel merged commit c823f3c into kata-containers:master May 17, 2018
devimc pushed a commit to devimc/kata-documentation that referenced this pull request Sep 2, 2019
initrd-builder: fix initrd image name
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
release-gating Release must wait for this to be resolved before release
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants