|
| 1 | +# Enclave Upgrade Guide |
| 2 | + |
| 3 | +## Overview |
| 4 | + |
| 5 | +An Enclave upgrade is the process of updating the deployed infrastructure to a new Enclave release. Each Enclave tarball is distributed with a tested combination of: |
| 6 | + |
| 7 | +1. **Enclave automation** (playbooks, scripts, configuration) |
| 8 | +2. **Management Cluster OpenShift version** (e.g., 4.20.8) |
| 9 | +3. **Operator versions** (ACM, Quay, etc.) |
| 10 | + |
| 11 | +The tarball contains all version definitions in `defaults/*.yaml` files and is the artifact as-is—a complete, tested release. |
| 12 | + |
| 13 | +### The Upgrade Process |
| 14 | + |
| 15 | +Upgrading to a new Enclave release follows this sequence: |
| 16 | + |
| 17 | +1. **Deploy new Enclave tarball** - Extract new release to Landing Zone, preserving your `config/*.yaml` customizations |
| 18 | +2. **Sync/Mirror new content** - Run sync process to download and mirror new OpenShift and operator images to local registry (disconnected mode) |
| 19 | +3. **Upgrade the management cluster** - Update OpenShift to the version specified in the new tarball |
| 20 | +4. **Upgrade operators** - Update operators to the versions specified in the new tarball |
| 21 | +5. **Validation** - Verify all components are healthy and at expected versions |
| 22 | + |
| 23 | +**Key Principle**: Each Enclave tarball is a versioned release with a pre-defined set of component versions. Upgrades move from one tarball release to another. |
| 24 | + |
| 25 | +**Important**: Components must be upgraded in order—tarball first, then sync content, then cluster, then operators. |
| 26 | + |
| 27 | +--- |
| 28 | + |
| 29 | +## Upgrading to a New Enclave Release |
| 30 | + |
| 31 | +Each Enclave tarball release includes: |
| 32 | +- Automation code (playbooks, scripts) |
| 33 | +- Tested version matrix (OpenShift, operators, control binaries) in `defaults/*.yaml` |
| 34 | +- Bug fixes and new features |
| 35 | +- Updated documentation |
| 36 | + |
| 37 | +### Upgrade Steps |
| 38 | + |
| 39 | +1. **Obtain new tarball** - Download the new Enclave release tarball |
| 40 | +2. **Backup configurations** - Save your `config/*.yaml` files (these contain your site-specific settings) |
| 41 | +3. **Extract tarball** - Deploy to Landing Zone, replacing automation and defaults |
| 42 | +4. **Restore configurations** - Copy your `config/*.yaml` files back (or merge if needed) |
| 43 | +5. **Validate configuration** - Ensure your configs are compatible with new release |
| 44 | +6. **Sync content** - Run sync process to mirror new versions (disconnected mode) |
| 45 | +7. **Upgrade management cluster** - Update OpenShift to version in tarball |
| 46 | +8. **Upgrade operators** - Update operators to versions in tarball |
| 47 | + |
| 48 | +--- |
| 49 | + |
| 50 | +## Resources |
| 51 | + |
| 52 | +- [Enclave Deployment Guide](DEPLOYMENT_GUIDE.md) |
| 53 | +- [Configuration Reference](CONFIGURATION_REFERENCE.md) |
| 54 | +- [OpenShift Upgrade Documentation](https://docs.openshift.com/container-platform/latest/updating/index.html) |
| 55 | +- [Red Hat Life Cycle Policy](https://access.redhat.com/support/policy/updates/openshift) |
| 56 | + |
| 57 | +--- |
| 58 | + |
| 59 | +**Note**: This is a high-level guide. Consult OpenShift and operator-specific documentation for detailed upgrade procedures and troubleshooting. |
0 commit comments