DOC: Allow overriding overrides in backup during restore

Bug #2067903 reported by Elisamara Aoki Gonçalves
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
StarlingX
Fix Released
Medium
Elisamara Aoki Gonçalves

Bug Description

Brief Description
-----------------

New feature + option was added to restore playbook to allow overriding values in the backup during restore operation.

Description

In the backup there is a file that contains values for puppet.
E.g. opt/backups/ansible.io2xfn4d/override/localhost_override_backup.yml
Some of these values can become out of date depending on situation.
Like if the registry credentials have changed.

To use these new overrides there are two new options:
* restore_overrides
* restore_overrides_recursive

Examples

To override entire docker registry section:

1. Create file: restore_overrides.yaml
---
restore_overrides:
  docker_registries:
    defaults:
      type: docker
      username: admin
      password: Hello123!
    docker.elastic.co:
      url: example.com/stx/docker.elastic.co
    docker.io:
      url: example.com/stx/docker.io
    gcr.io:
      url: example.com/stx/gcr.io
    ghcr.io:
      url: example.com/stx/ghcr.io
    icr.io:
      url: example.com/stx/icr.io
    k8s.gcr.io:
      url: example.com/stx/k8s.gcr.io
    quay.io:
      url: example.com/stx/quay.io
    registry.k8s.io:
      url: example.com/stx/registry.k8s.io

2. Run restore:
ansible-playbook restore_platform.yml \
  -e restore_mode=optimized \
  -e "@/path/to/restore_overrides.yaml"

To override only password:

1. Create file: restore_overrides.yaml
---
restore_overrides_recursive: true
restore_overrides:
  docker_registries:
    defaults:
      password: Hello123!

2. Run restore:
ansible-playbook restore_platform.yml \
  -e restore_mode=optimized \
  -e "@/path/to/restore_overrides.yaml"

Severity
--------

<Minor: System/Feature is usable with minor issue>

Changed in starlingx:
assignee: nobody → Elisamara Aoki Gonçalves (egoncalv)
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix proposed to docs (master)

Fix proposed to branch: master
Review: https://review.opendev.org/c/starlingx/docs/+/921078

Changed in starlingx:
status: New → In Progress
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to docs (master)

Reviewed: https://review.opendev.org/c/starlingx/docs/+/921078
Committed: https://opendev.org/starlingx/docs/commit/76ab0651f7e86fbe2cda886e8ec92752bb3d5f8b
Submitter: "Zuul (22348)"
Branch: master

commit 76ab0651f7e86fbe2cda886e8ec92752bb3d5f8b
Author: Elisamara Aoki Goncalves <email address hidden>
Date: Mon Jun 3 20:43:28 2024 +0000

    Allow overriding overrides in backup during restore

    Closes-bug: 2067903

    Change-Id: Ic04cbf1295fdbc5a3c05fc8467c79df7044c3b6e
    Signed-off-by: Elisamara Aoki Goncalves <email address hidden>

Changed in starlingx:
status: In Progress → Fix Released
Ghada Khalil (gkhalil)
Changed in starlingx:
importance: Undecided → Medium
To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.