Bundle Your Application Artifacts
As a service administrator, you can manage snapshots of your application artifacts as bundles.
LiveLabs Sprint: How do I backup and restore my environment using bundles?
LiveLabs Sprint: How do I create and deploy security bundles?
LiveLabs Sprint: How do I generate content bundles?
LiveLabs Sprint: How do I create and deploy semantic model bundles?
About Bundles
Bundles are snapshots of your application artifacts such as configurations and customizations at a certain point in time.
Bundles work on environments where the source and target are at the same level or the source is at a lower version and the target is at a higher version. For example, a bundle generated from a previous content version works on the latest content version. Ensure that your bundle size is less than 1 GB. If the bundle size exceeds 1 GB, then enter a service request in My Oracle Support. Prior to deployment, the system validates the bundles to confirm whether the bundles contain all prerequisites. If there is a validation error, then you see the applicable bundle with "Validation Failed" status and you can't deploy it. You must fix the issue and try to deploy again.
- Package custom development by defining a bundle that represents a subset of application artifacts in an environment such as development, test, or production.
- Migrate custom development and deploy the bundle on a target environment.
- Synchronize instances by promoting changes from one environment to another such as production to test.
- Restore the system when something goes wrong with an environment and you need to do a complete system restore.
- Create a backup of the environment or subset of application to save current state of the artifacts.
- Restore artifacts by importing from a bundle to restore state of the relevant artifacts to what was in the bundle.
You can bundle your application artifacts as:
- Data Config bundle: This includes pipeline parameters, activation metadata, data augmentations, and custom data configurations. You can install this bundle in an existing environment after a hard data reset. This is useful to leave content as-is and reset the data pipeline. When you bundle data configurations, only the deployed data augmentations or configurations are included. Augmentations or configurations that aren't in deployed state in the source instance won't be included in a data configuration bundle.
- Semantic Model bundle: This includes main branch, tags, custom branch, and all the security customizations. Use this bundle to import the semantic model extensions because it allows you to select which tag and version to publish and what to publish.
- Security bundle: This includes custom application roles and custom data security.
- Content bundle: This includes snapshots of Oracle Analytics Cloud folders, projects, dataset definitions,workbooks, duty roles for content, and report parameters. The content bundle always merges the catalog content from source to target. While merging, if any conflicts are found, it replaces the content. It doesn't track the deleted content.
- Composite bundle: This includes one or more of the other bundles.
- Environment bundle: Environment bundle publishes the original semantic model without the customizations. This includes all artifacts of a specific environment to revert to a known state of system. For example, at the end of every week, the service administrator can create a bundle called DevEnv_YYMMDD to maintain a backup of the environment. You must first deploy the data configuration bundle or manually activate your data pipelines before deploying the environment bundle.
Ensure that you've activated the functional areas and data is available prior to working with the semantic models or content. Either manually configure and activate your data pipelines in the target environment, or deploy a Data Config bundle to ensure that configurations and activations are at the same level as the source environment. Only then, it makes sense to deploy an Environment bundle, Semantic bundle, or Composite bundle because they depend on data.
- Include the applicable security-related information in the Semantic Model and Content bundles.
- Reassign the groups to the users because the Security bundle doesn’t overwrite the user-group mappings.
- Include the security configuration when you’re exporting a Semantic Model bundle from a test to a production environment.
- While creating a Security bundle, if the number of application roles exceed 1000, then you may encounter an error. In such a case, use the Select Application Roles button to select specific roles.
- Use unique names for the semantic model extension steps. This enables the tags to work correctly while using the Content bundle to migrate your content to the target instance.
What’s Available In Bundles
Learn what's available in bundles.
Area | Artifact | Included in Bundles |
---|---|---|
Security | Application roles | Security and Environment |
Security | Users and Groups | No – move manually, done in Identity Cloud Service |
Security | Group to Role assignments | Security and Environment |
Security | Security contexts including Configurable Context | No – move manually |
Uploaded files | Financial Categories, Security assignments | No – move manually |
System settings | Oracle Analytics Cloud system settings including Preview features | No – create manually in target environment |
Enable features | Activated Oracle Fusion Data Intelligence features | No – create manually in target environment |
Semantic model extensions | System, user, security configuration | Semantic and Environment |
Data validations | Scheduled validations such as AP Invoices, weekly | No – create manually in target environment |
Oracle Analytics Cloud content | ||
Key metrics, Workbooks, Connections, Analyses | Content and Environment | |
Data flows, Functions, Machine Learning apps | Environment | |
Key metrics | No – create service request | |
Datasets | No – move manually | |
Reporting configurations | Basic reporting configurations | Content |
Reporting configurations | Advanced (Configurable Account Analysis) | No – create manually in target environment |
Data pipeline | Pipeline parameters, functional areas, augmentations | Data configurations |
Data pipeline | Frequent refresh modules, tables, prioritized refresh | No – create manually in target environment |
Data pipeline | Warehouse full reload schedules | No – create manually in target environment |
Data pipeline | Custom data configurations – DFFs, custom applications such as Configurable Account Analysis | No – create manually in target environment |
Connections | Data Augmentation Connectors | No – create manually in target environment |
Oracle Cloud Infrastructure Console settings | Entitlements, connections, PaaS component settings | No – create manually in target environment |
Oracle Autonomous Data Warehouse custom schema | OAX_USER schema objects and data | No – use data pump to back up to and restore from Oracle Object Storage Service |
Create a Bundle
Create a snapshot of your application artifacts to save their current state. You can view the bundles that you created on the Bundles page.
While creating a bundle in your source instance, ensure that you select only the data sources that are also available in the target instance to avoid deployment failures in the target instance.
For an application bundle, ensure that you raise a service request to have this option made available. Then enable the Application Bundle feature from the Preview tab on the Enable Features page.
Prior to creating and generating a content bundle, ensure that none of the datasets have names with special characters. Also, if some of the datasets don't have key metrics to back up, manually select the key metrics from the respective subject areas and datasets and regenerate the content bundle. If there aren't any key metrics to back up in the bundle, then you can only select the OAC Content option from the user interface.
Publish a Bundle
Publish a bundle from the source environment. This action generates a snapshot of the application artifacts and saves the snapshot to a repository. You can download this bundled artifact and import it into different instances.
Export a Bundle
Export the bundle .aab file from your source system to a repository or your local machine.
Import a Bundle
Import the bundle .aab file into the target environment from your computer to restore the state of the application to the checkpoint represented by the bundle.
Deploy a Bundle
You can deploy a generated bundle in the target environment to revert to the state of artifacts represented by the bundle. The system validates the bundle before attempting any deployment to ensure software and model versions and any other dependencies are met.
Delete a Bundle
Delete a bundle if you no longer require the snapshot of your application artifacts captured in the bundle.
View the Activity History of Bundles
View all the bundles-related activities to understand the changes made to your instance, which bundles to use, and whether the existing bundles are still current. This information enables you to make informed decisions about creating updated bundles or deploying an existing bundle.