Upgrade
The world of Microservices moves fast. In order to keep up with new software versions and provide additional features, regular updates and patches are provided for the Oracle Backend for Spring Boot and Microservices.
Depending on the original installation method and the state of your infrastructure, these patches and upgrades can either be preformed in-place or out-of-place. Oracle recommends, despite which option you choose, to have a backup of your applications and database in order to recover from any unintentional loss.
There are various methods to perform an upgrade including:
- In-Place Marketplace Upgrade
- Out-of-Place Marketplace Upgrade
- In-Place Custom Upgrade
- Out-of-Place Custom Upgrade
The in-place Marketplace upgrade can be performed when there has been no external modifications of the infrastructure after the original installation of the Marketplace stack; or you wish to reconcile the infrastructure back to the delivered Marketplace infrastructure.
The in-place method will both modify the infrastructure and patch/upgrade the delivered Oracle Backend for Spring Boot and Microservices applications.
This method is recommended for development deployments, or after testing the upgrade using the Out-of-Place Upgrade for production deployments.
Warning: to ensure no unintentional outage or infrastructure destruction; do not directly apply the upgrade stack. Plan and review the actions that will be performed prior to its application. If in doubt about the potential loss of data or infrastructure, opt for the Out-of-Place method.
Visit the Release page and download the marketplace_upgrade.zip file for the version you are upgrading to.
In Oracle Cloud Infrastructure, navigate to Developer Services -> Stacks. Ensure the region and compartment is set to the location where the Marketplace stack was first installed, and select the stack.
Edit the Stack, and upload the marketplace_upgrade.zip file.
Click through the wizard and ensure the “Apply” checkbox is not ticked. Save Changes.
Run the plan Job and review the proposed actions.
Generally, any proposed destruction of the Database or Kubernetes cluster should be avoided unless you are confident that you can recover both your applications and data. If the plan shows the destruction of these resources, the Out-of-Place Upgrade should be used as an alternative.
The out-of-place Marketplace upgrade can be used when manual changes to the original infrastructure have been made after the initial installation of the Oracle Backend for Spring Boot and Microservices. It is the recommended Marketplace method for production installations as it allows you to test the upgrade prior to go live, while leaving the old infrastructure in place for rollbacks.
The out-of-place method deliver new infrastructure and Oracle Backend for Spring Boot and Microservices applications. You will need to migrate your applications to the new platform.
Follow the instructions to install the latest Marketplace version.
Depending on the Oracle Database that was used during the initial installation, the method of cloning the database will vary. For example:
- Oracle Autonomous Database
- Oracle BaseDB
- On-Premises options include:
Once the database has been cloned, re-load your applications into the new Kubernetes environment.
Follow the uninstall guide to clean up the old Marketplace installation.
The Custom In-Place upgrade can be applied to any existing installation of the Oracle Backend for Spring Boot and Microservices. It will not modify any infrastructure and only apply changes to existing and install new Oracle Backend for Spring Boot and Microservices applications.
Visit the Release page and download the custom-ebaas_latest.zip file for the version you are upgrading to.
Unzip the custom-ebaas_latest.zip file.
From the original installation source, copy the following infrastructure definitions, where they exist, to the new release source:
- ansible/roles/common/vars/main.yaml
- ansible/roles/registry/vars/main.yaml
- ansible/roles/database/vars/main.yaml
- ansible/roles/oci/vars/main.yaml
- ansible/roles/azure/vars/main.yaml
From the unzipped source, run the following commands:
./setup_ansible.sh
source activate.env
ansible-playbook ansible/k8s_apply.yaml -t full
The custom out-of-place upgrade assumes you have out-of-place infrastructure to install into. The existing Oracle Database should be cloned for use with the new version.
Visit the Release page and download the custom-ebaas_latest.zip file for the version you are upgrading to.
Unzip the custom-ebaas_latest.zip file.
Depending on the Oracle Database that was used during the initial installation, the method of cloning the database will vary. For example:
- Oracle Autonomous Database
- Oracle BaseDB
- On-Premises options include:
From the original installation source, copy the following infrastructure definitions, where they exist, to the new release source:
- ansible/roles/common/vars/main.yaml
- ansible/roles/registry/vars/main.yaml
- ansible/roles/database/vars/main.yaml
- ansible/roles/oci/vars/main.yaml
- ansible/roles/azure/vars/main.yaml
Update the files to point to the new out-of-place infrastructure.
From the unzipped source, run the following commands:
./setup_ansible.sh
source activate.env
ansible-playbook ansible/k8s_apply.yaml -t full
Once the upgrade is complete, re-load your applications into the new Kubernetes environment.