Creating a private image
1
Select your starter image
Select an image from your Minimus subscription to begin. There’s no need to select the image line or version.
2
Select packages to add
Your starter image is the base upon which you add packages. You can search the list of packages by name, description and version. Once you make your selection, the added packages are shown in the right preview panel, where you can review your final selection and remove packages if needed.The complete listing of Minimus packages are available, including the Minimus Cryptographic Module (for FIPS images).To view your starting point, expand the folder starter image packages in the right preview panel. It lists the SBOM of the latest production version of the starter image.
The SBOM of the
The final number of packages added will depend on the package dependencies. Dependencies are detected at the build stage and will be listed in the private image SBOM.
latest starter image is used as the baseline (not latest-dev). Add dev tools such as a package manager and shell if needed.The final number of packages added will depend on the package dependencies. Dependencies are detected at the build stage and will be listed in the private image SBOM.
3
Add custom environment variables
You can add custom env variables (short for environment variables) to pass configuration settings into the container at runtime without hardcoding them in the image. These may include ports, credentials, modes, etc.
- Avoid duplicate keys as they will cause the build to fail. This is to protect against overrides that can interfere with the starter image configurations.
- You can add key-value pairs. Key-only variables (also, empty environment variables) are not accepted.
- Once you make your updates, your custom env variables are shown in the right preview panel, where you can review them and remove them if needed.
4
Set image details
The next step is to give your private image a name and optionally, provide a description. Your organization’s tenant ID will be prepended to the image name to clearly indicate that it is private to your organization. You image will also marked with the label private image.Read the testing recommendations then save your image.
Slashes are not allowed in the image name.
5
Wait for the image to be built
While the image is being built, it’s card will be shown in the Image Creator gallery with a status label - in progress. The build generally takes under 20 minutes, depending on the components.
- When the image is ready, it will appear with the label created and will show a timestamp of when it was first created. Click the button view image to dive into the image card.
6
Testing your private image
Testing your private image for functionality is the next step. Minimus standard images undergo strict unit testing as described in our architecture article. Since testing is particular to the exact components of the image, Minimus is not able to cover all testing requirements.
Managing private images
Viewing your private images
To view your gallery of private images, go to Image Creator. Here you can create a new private image and manage your existing private images. In the regular image gallery, your private images are labeled as private images and have a name that begins with your Minimus ID.
Editing a private image
You can update the added packages and env variables for your private images. The starter image and image name are fixed and cannot be changed. Once updated, the private image will be rebuilt. To edit a private image, go to Image Creator and select Edit in the image menu.Deleting a private image
Private images are all about experimentation. Easily remove outdated or unhelpful private images from your Minimus console. To edit a private image, go to Image Creator and select Delete in the image menu.Troubleshooting a failed build
If your private image was not successfully built, contact our team for assistance. Please provide the error code if possible. The image may fail to build due to conflicts or incompatible components. Our team is at your service to help resolve the issues.