Managing base configurations

From the Deployment Manager Base Configs tab, you can add services, update images of existing services, and perform other tasks related to managing your deployment’s base configurations.

Warning

Never directly edit the base configuration files provided by Instabase to make configuration changes. Always use the configuration management tools on the Configs and Base Configs tabs instead. See the configuration management documentation for guidance on using patches to modify your base configurations.

Adding new services

You can add new, individual services to your Instabase instance by uploading a .zip file containing only as many configuration files as needed to create your new services.

To add new services to your Instabase instance:

  1. Define your services as .yml files.

  2. Create a release version file.

    1. Open a blank file in a text editor.

    2. Enter the current release version of your Instabase instance, including the patch number, if applicable. For example, 22.08.0 or 22.10.1.

    3. Save the file as release_version, with no file extension.

  3. Compress your .yml files and release_version file into a .zip file.

  4. Open the Deployment Manager Base Configs tab (All apps > Deployment Manager > Base Configs).

  5. Select the Create Objects tab.

  6. Upload the .zip file:

    • Click Browse and select the file from your file explorer.

    • Drag and drop the file onto the pane labeled Upload a new set of zipped base config files to upgrade your instance of Instabase.

  7. Click Create Objects.

  8. Click Confirm.

You can use the Deployment Manager Infra Dashboard to track when the service has been added.

Updating a service’s image

Info

Only site admins can perform image updates.

When updating a service’s image, you need the following information:

  • Object: The object to update the image for. You can select this from a dropdown populated with all available objects.

  • Image: The new image value. For example, gcr.io/instabase-public/image:tag.

  • Comment: A comment summarizing the change the image provides. For example, numpy-package-update.

  • Container: The container to update the image for. You can select this from a dropdown if the object has more than one container.

To update a service’s image:

  1. Open the Deployment Manager Base Configs tab (All apps > Deployment Manager > Base Configs).

  2. Select the Update Image tab.

  3. Select an object from the Object dropdown.

  4. Enter the image in the Image field.

  5. Enter a comment in the Comment field.

  6. Select a container from the Container dropdown.

  7. Click Update Image.

You can use the Deployment Manager Infra Dashboard to track when the image has been updated.

Update base configurations

You can update your deployment’s base configurations from the Base Configs tab, with some restrictions:

  • The release version of the uploaded base configurations must match the release version of your current base configurations.
  • Uploading base configurations with a comment is allowed, if the major/minor/patch values are the same, such as uploading 23.01.01-custom-version when currently running 23.01.01.

Updating base configurations through the Base Configs tab does not support version upgrades; to complete a version upgrade, use the Upgrades tab.

  1. Open the Deployment Manager Base Configs tab (All apps > Deployment Manager > Base Configs).

  2. Select the Create Objects tab.

  3. Upload the base configurations file:

    • Click Browse and select the file from your file explorer.
    • Drag and drop the file onto the pane labeled Upload a new set of zipped base config files to upgrade your instance of Instabase.

  4. Click Create Objects.

  5. Click Confirm.

View past base configurations

The Entries tab of the Base Configs tab provides a record of previous base configurations that have been used in the deployment, sorted by release version. Each entry includes who added the base configuration and on what date.

Selecting an entry displays a configurations pane, where you can review the configurations for all objects in the configuration. One object displays at a time; you can click the Prev and Next buttons to navigate through the objects, or select a specific object from the object dropdown.