Manage resource snapshots
Manage resource snapshots
Your Coveo deployment probably includes more than one organization. Typically, Coveo customers have a production organization and at least one non-production organization. Since most of the changes you make in Coveo are effective immediately, a good practice is to test them in a non-production organization before applying them to your production organization.
To this end, the resource snapshot feature allows you to copy resource (for example, source, field, and query pipeline) configurations from one organization to the other, rather than reproducing them manually in a second organization. This feature is especially useful when you manage a large number of resources and want to make bulk changes.
Overall, the resource snapshot feature allows you to:
-
Copy multiple resource configurations from one organization to the other.
-
Review a diff of the changes you import in an organization.
-
Save snapshots as backups.
-
Revert your changes by importing a previous configuration.
-
Download and import snapshots into a version control tool.
|
Note
Not all resource types can be included in a snapshot yet, although the current offer should cover multiple use cases. See Supported resources for a list of the resource types that the snapshot feature supports. If you would like to include additional resource types in a snapshot, contact your Coveo representative. We will consider further expanding the snapshot feature depending on the demand. |
Documentation subdivision
The resource snapshot management documentation is divided as follows. Readers are advised to read these articles in order, and then to come back to the current page to follow the instructions below when ready to start working with snapshots.
|
To manage snapshots programmatically, also read how to Manage organization snapshots with the Coveo CLI. If you have developer skills, the CLI greatly reduces manual intervention and lets you simplify your deployments with modern infrastructure-as-code. |
Create a snapshot of your organization
To create a new resource snapshot in an organization, you can either import a snapshot file saved on your computer or generate a snapshot of your organization in its current state.
To generate a snapshot:
-
On the Resource Snapshots (platform-ca | platform-eu | platform-au) page, click Create snapshot, and then select Of your organization.
-
In the Create a snapshot subpage, enter a name for your snapshot, and then click Next.
-
Select domains to include in the snapshot. You’ll be able to select specific resources later.
-
Include resource dependencies is recommended and enabled by default. This means your snapshot contains the desired resources as well as the other resources they rely on. This ensures that the resources you copy to a different organization work identically to those in the original organization. For example, a snapshot of a source would include its fields, mappings, extensions, and security provider.
-
Click Next.
-
Optionally, select specific resources to include in your snapshot. If you don’t specify any resources, the snapshot will contain all resources in the selected domain by default.
-
Click Create snapshot or, alternatively, click Save for CLI to download your selection for usage in Coveo CLI.
|
|
Note
Not all resource types can be included in a snapshot yet, although the current offer should cover multiple use cases. See Supported resources for a list of the resource types that the snapshot feature supports. If you would like to include additional resource types in a snapshot, contact your Coveo representative. We will consider further expanding the snapshot feature depending on the demand. |
On the Resource Snapshots (platform-ca | platform-eu | platform-au) page, click your snapshot to review the details of the resources in it.
Copy a snapshot to another organization
Once you’ve created a snapshot of your organization, you should want to copy it to a different organization where you’ll apply it.
-
On the Resource Snapshots (platform-ca | platform-eu | platform-au) page, click the desired snapshot, and then click Copy to in the Action bar.
-
In the Copy snapshot to another organization panel that opens, enter a name for your snapshot in the destination organization.
-
Under Target organization, select a destination organization.
-
Click Copy.
Apply a snapshot to an organization
Applying a snapshot to an organization imports the resource configurations included in the snapshot. If the destination organization contains a different version of a resource included in the snapshot, the snapshot version replaces this version.
-
On the Resource Snapshots (platform-ca | platform-eu | platform-au) page, select the desired snapshot, and then click Apply in the Action bar.
-
The subpage that appears shows whether the prerequisites are met:
-
Coveo checks whether you have the privileges to edit the resources in the snapshot, as they’re required to apply the snapshot. If you don’t have all of these privileges, contact your Coveo administrator.
-
Coveo also checks whether it has all the information it needs. Some sensitive pieces of information may be needed to create or update your resources properly (for example, source credentials). In such case, click Allow import to import them from the origin organization, or provide them manually through Coveo’s API.
-
-
Once all prerequisites are met, click Next. Coveo will check whether your snapshot is valid and can be applied.
-
Once the validation process is complete, you can review the changes to apply. If errors are detected in some resources, you may want to review them as well, and perhaps modify your snapshot or organization resources to fix them.
-
Once all errors are fixed, click Next, and then, in the dialog, confirm that you want to apply the snapshot.
To review the changes applied to an organization, we recommend you use the Activity Browser (platform-ca | platform-eu | platform-au).
Limits
-
An organization can contain up to 20 snapshots. Should you create or import more, the oldest will be deleted.
-
Snapshots are automatically deleted 6 months after their creation.
Supported resources
Not all resource types can be included in a snapshot yet, although the current offer should cover multiple use cases.
If you would like to include additional resource types in a snapshot, contact your Coveo representative. We will consider further expanding the snapshot feature depending on the demand.
The snapshot feature supports the following resources:
| Resources | Dependencies |
|---|---|
Fields |
N/A |
Extensions |
N/A |
Query pipelines |
|
Search pages built with the legacy Interface Editor |
N/A |
Machine learning models |
|
Notifications |
N/A |
Sources |
|
Security providers |
N/A |
Insight Panels |
|
Catalogs (catalog entities) |
|
Known issue
A minor issue occurs when applying a snapshot that contains a source that indexes permissions, if this snapshot is imported from a different organization. A security provider is created successfully, but its ID includes the name of the origin organization rather than the name of the destination organization.
Coveo is aware of this issue and will fix it in an upcoming release. In the meantime, Coveo has validated that this problem doesn’t hinder your work.
What’s next?
See the Basic resource snapshot workflow to understand how resource snapshots are created, and then imported and applied to a different organization.
Very useful
Not really
Very useful
Not really