Skip to content

Commit

Permalink
Add kolla image update information (#121)
Browse files Browse the repository at this point in the history
* add kolla image build history
* add guide for updating kolla images
  • Loading branch information
muertos authored Oct 11, 2024
1 parent 8c93172 commit 76fa648
Show file tree
Hide file tree
Showing 5 changed files with 116 additions and 3 deletions.
51 changes: 51 additions & 0 deletions docs/kolla-image-update/build-history.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
# Kolla Image Build History

This page tracks the history of when Kolla images have been built. Images are
built when major security issues are patched in the base image operating system
and when changes to OpenStack services, like bug fixes and improvements, are
released. OpenStack service changes can be found in the [release notes](https://docs.openstack.org/releasenotes/)
index.

## Current OpenStack release

We are currently deploying OpenStack 2023.2 with Ubuntu 22.04 as the base
operating system.

## Image tagging

When images are built, the date they were built is appended to the image tag, in
the format "YYYY-MM-DD". Images built on October 10, 2024 for the 2023.2 release
will be tagged with `2023.2-ubuntu-jammy-2024-10-10`. The latest images built
will have two tags applied, one being the base tag (`2023.2-ubuntu-jammy`, for
example), and the other including the appended date. This allows for rolling
back to previous images if necessary.

## How to update your cloud

See [Update Kolla Images](../operators-manual/day-2/update-kolla-images.md) for
the steps needed to update your cloud.

## OpenStack 2023.2

Latest image tag: `2023.2-ubuntu-jammy`

### Ubuntu 22.04 LTS (Jammy) Security updates

See the [Ubuntu Security Notices](https://ubuntu.com/security/notices?order=newest&release=jammy&details=&offset=0)
page for information relating to security updates.

### OpenStack service updates

OpenStack service changes can be found in the [release notes](https://docs.openstack.org/releasenotes/)
index.

### Image Update History

| Tag | Build Date | Notes |
|--------------------------------|------------|-----------------------------------------------------------------------------------------------------------------------------------------------------|
| 2023.2-ubuntu-jammy-2024-10-10 | 10/10/2024 | - [Ubuntu security updates](https://ubuntu.com/security/notices?order=newest&release=jammy&details=&offset=0) |
| | | - [Cinder (23.2.0-12) new features and bug fixes](https://docs.openstack.org/releasenotes/cinder/2023.2.html#relnotes-23-2-0-12-stable-2023-2) |
| | | - [Neutron (23.2.0-18) security issues and bug fixes](https://docs.openstack.org/releasenotes/neutron/2023.2.html#relnotes-23-2-0-18-stable-2023-2) |
| | | - [Nova (28.3.0-11) bug fixes](https://docs.openstack.org/releasenotes/nova/2023.2.html#relnotes-28-3-0-11-stable-2023-2) |
| | | - [Octavia (13.0.0-32) bug fixes](https://docs.openstack.org/releasenotes/octavia/2023.2.html#relnotes-13-0-0-32-stable-2023-2) |
| | 9/5/2024 | |
5 changes: 2 additions & 3 deletions docs/operators-manual/day-2/maintenance.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,9 +28,8 @@ Ceph updates are handled through the node's package manager.

## Updating Kolla Ansible Docker Images

Refer to Kolla Ansible's
[documentation](https://docs.openstack.org/kolla-ansible/latest/user/operating-kolla.html#upgrade-procedure)
for more information regarding updating images.
See [Update Kolla Images](../../operators-manual/day-2/update-kolla-images.md)
for the steps needed to update your cloud.

## Performing Package Manager Updates

Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
---
sidebar_position: 6
---
# Manage Node Firewall Using iptables

## Use Case
Expand Down
52 changes: 52 additions & 0 deletions docs/operators-manual/day-2/update-kolla-images.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
---
sidebar_position: 7
---
# How to Update Kolla images

Updating your cloud's Kolla images is an important part of improving the
security of your OpenStack cloud. Improvements, bug fixes, and security patches
for OpenStack services are also a benefit of updating your cloud's images.

## Prepare Kolla Ansible

To update the Kolla images, first [prepare your Kolla Ansible environment](../day-4/kolla-ansible/prepare-kolla-ansible.md).

## Freeze changes to cloud

Make sure the OpenStack service databases are not modified during this
maintenance window. This includes things like creating/deleting VMs, networks,
routers, etc.

## Backup OpenStack databases

Back up your cloud's MariaDB databases, just in case.

```sh
kolla-ansible -i inventory.yml -i ansible/inventory/multinode mariadb_backup
```

## Pull images

Pull in updated Kolla images. You can confirm when image updates are available
by visiting [Kolla Image Build History](../../kolla-image-update/build-history.md).

```sh
kolla-ansible -i inventory.yml -i ansible/inventory/multinode pull
```

## Kolla deploy-containers

Deploy updated containers.

```sh
kolla-ansible -i inventory.yml -i ansible/inventory/multinode deploy-containers
```

## (Optional) MariaDB recovery

If you run into issues with MariaDB containers not starting up during the
deployment of containers, you can try recovering MariaDB.

```sh
kolla-ansible -i inventory.yml -i ansible/inventory/multinode mariadb_recovery
```
8 changes: 8 additions & 0 deletions sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,14 @@ const sidebars = {
{type: 'autogenerated', dirName: 'operators-manual'},
],
},
{
type: 'category',
label: 'Kolla Image Updates',
link: {type: 'doc', id: 'kolla-image-update/build-history'},
items: [
{type: 'autogenerated', dirName: 'kolla-image-update'},
],
},
{
type: 'category',
label: 'User\'s Manuals',
Expand Down

0 comments on commit 76fa648

Please sign in to comment.