Adding a new version of your container product on AWS Marketplace

As an AWS Marketplace seller, you can add new versions of your container product, manage versions, and update version information. Your product might have several versions over its lifetime. Each version has a set of container images that are specific to that version. The following topics show you how to manage product versions for your container products.

Note

You can't add a version to your product until you have created the product ID and the pricing for your product. For more information about those steps, see Step 1: Create the product ID and product code for your container product.

Step 1: Add repositories

Your container images and other artifacts for your product are stored in repositories in AWS Marketplace. Typically, you create one repository for each artifact needed, but the repository can store multiple versions of the artifact (with different tags).

Note

All images in your product deployment must use images from the AWS Marketplace repositories.

The following procedure describes how to add any needed repositories in AWS Marketplace.

To add repositories

1. Sign in to the AWS Marketplace Management Portal.

2. Select Server from the Products menu.

3. On the Server products tab, select the product you want to modify, and then choose Add repositories from the Request changes dropdown.

4. Enter the name for the repository that you want to create. If you want to create more than one new repository, choose Add new repository for each additional repository, and give it a unique name.

   Note

   The repository will have this structure: <repositoryID>.dkr.ecr.us-east-1.amazonaws.com/<sellerName>/<repositoryName>. When you add items to the repository (in the following procedure), they will get a tag and have this structure: <repositoryID>.dkr.ecr.us-east-1.amazonaws.com/<sellerName>/<repositoryName>:<tag>. The repositoryID is an internal ID for AWS Marketplace. The sellerName is based on the name you created for your seller account. You define the respositoryName in this step. The tag is set when you upload an artifact to the repository.

5. Select Submit.

Note

You can have up to 50 repositories per product.

A new request is created and shown on the Requests tab. When it's completed, within minutes, you can start adding container images and other artifacts to the repositories you have created.

Step 2: Upload container images and artifacts to repositories

To upload container images and artifacts to repositories

1. Sign in to the AWS Marketplace Management Portal.

2. From the Products menu, choose Server.

3. On the Server products tab, select the product you want to modify.

4. Choose Add repositories from the Request changes dropdown.

5. Choose View existing repositories.

6. Select the repository to which you want to upload.

7. Select View push commands to open a list of instructions, including commands you can use to push Docker container images and Helm charts to that repository.

   For general information about how to push container images and other artifacts to repositories, refer to Pushing an image in the Amazon Elastic Container Registry User Guide.

   Note

   You can use the following Amazon Elastic Container Registry (Amazon ECR) API operations when calling docker pull or docker push:

   • DescribeImages – Use this to review the metadata about the images in a repository.

   • GetAuthorizationToken – Use to authenticate before uploading artifacts to the repository, then use docker pull or docker push commands.

   • ListImages – Use to view a list of images you pushed.

8. Use the commands listed to push any needed artifacts from your local repository to the AWS Marketplace repository for your product.

   Note

   The tag that you provide in the push commands is used to differentiate the version of the artifact that you are uploading to the repository. Use a tag that makes sense for the version the artifacts are a part of.

9. Repeat for each container image or artifact you need in your version.

   Note

   Your version can include up to 50 container images or artifacts in each delivery option. Refer to the following procedure for more information about delivery options.

After you upload your artifacts, you're ready to create the version of your product.

Note

Your container images are scanned automatically to see if they meet the Container-based product requirements for AWS Marketplace. For more information, refer to Container product scans for security issues.

Adding a new delivery option

Each version of your container product would need a delivery option. Delivery option specifies the deployment options available for the buyer. Depending on one of the delivery options below, you would need to upload the appropriate artifacts into the repositories.

• For a Container image delivery option, upload all the container images required for the product installation into the Amazon Elastic Container Registry (Amazon ECR) repository created in the AWS Marketplace console.

• For a Helm chart delivery option, upload the Helm chart and container images into the Amazon ECR repository created in the AWS Marketplace console.

• For an Amazon EKS console add-on delivery option, upload the Helm chart and container images into the Amazon ECR repository created in the AWS Marketplace console.

Step 3: Add a new version to your container product

Note

If you receive any errors when adding a new version to your container, see the Add a new version Asynchronous Errors table in the AWS Marketplace Catalog API Reference.

To add a new version to your container product

1. Sign in to the AWS Marketplace Management Portal.

2. Choose Server from the Products menu.

3. On the Server products tab, select the product you want to add a version to. Then choose Add new version from the Request changes dropdown.

4. On the Add new version page, enter the Version title and Release notes for your version.

5. After entering the version details, the next step is to add delivery options. Delivery options are sets of instructions and information that buyers can use to launch the software from your product version. Delivery options are known as fulfillment options to buyers.

   Note

   Your product can support multiple platforms with different container images (for example, Kubernetes and Ubuntu deployments). You can create one delivery option for each way that customers can set up your product, up to four delivery options per version of the product.

   1. If the product already has delivery options in other versions, you can use the existing option as a template to add a delivery option to the new version. In Delivery options, choose the delivery option that you want to add from the list. You can edit the option using the instructions in the following steps.

   2. To add a new delivery option, choose New delivery option. After adding an option, follow the instructions in the following steps to configure it.

6. Choose a delivery method for the delivery option. The delivery method determines how buyers will launch your software.

   • For a Container image delivery option, provide paths to container images in an Amazon Elastic Container Registry (Amazon ECR) repository that was created in the AWS Marketplace console. Buyers use the container image paths to launch the software by pulling the images directly into their environments.

   • For a Helm chart delivery option, provide paths to Helm charts in an Amazon ECR repository that was created in the AWS Marketplace console. Buyers install the Helm charts in their deployment environment to launch the software.

   • For an Amazon EKS console add-on delivery option, provide paths to Helm charts in an Amazon ECR repository that was created in the AWS Marketplace console. Buyers install the container using the Amazon EKS console or native Amazon EKS add-on APIs to launch the software. For more information, see Available Amazon EKS add-ons from Amazon EKS.

   1. To add a Container image delivery option, perform the following steps:

      1. In Container images, add the Amazon ECR URL to the container images that contain the product version software.

      2. In Delivery option title and Deployment option description, enter a title and description for this delivery option.

      3. In Usage instructions, enter detailed information to help your buyers use your software after launching it.

      4. In Supported services, select the environments that buyers can launch the software in.

      5. In Deployment templates, add resources that buyers can use to launch the software. Enter a title and a URL to the resource for each template.

   2. To add a Helm chart delivery option, perform the following steps:

      1. In Helm chart, add the Amazon ECR URL to the Helm chart that buyers will install in their deployment environment to launch your software.

      2. In Container images, add the Amazon ECR URL to the container images that contain the product version software.

      3. In Delivery option title and Deployment option description, enter a title and description for this delivery option.

      4. In Usage instructions, enter detailed information to help your buyers use your software after launching it.

      5. In Supported services, select the environments that buyers can launch the software in.

      6. Optional - In Helm release name, enter the name of the Kubernetes namespace where the Helm chart will be installed.

      7. Optional - In Helm installation namespace, enter the name for the Helm release that will be used by the helm install command.

      8. Optional - In Kubernetes service account name, enter the name of the Kubernetes service account that will be used to connect to AWS Identity and Access Management (IAM). The Kubernetes service account calls AWS services such as licensing or metering.

      9. Choose to enable QuickLaunch on this product version. QuickLaunch is a feature in AWS Marketplace. Buyers can use QuickLaunch to create an Amazon EKS cluster quickly and launch your software on it by using AWS CloudFormation. For more information, see QuickLaunch in AWS Marketplace.

      10. In Override parameters, enter parameters that will be used in the Helm CLI commands that launch the software. These parameters allow buyers to override the provided default values. If you have enabled QuickLaunch, also enter a parameter name and description for the CloudFormation form. There is a limit of 15 parameters when using the AWS Marketplace Management Console, but there is no limit when using the AWS Marketplace Catalog API. For more information, see Adding a new version to a container-based product.

          Note

          Some Override parameters are required. Amazon EKS Anywhere products require an Override parameter for license secret with a DefaultValue of "${AWSMP_LICENSE_SECRET}". For paid products, you must provide one Override parameter for service account configuration with the DefaultValue of "${AWSMP_SERVICE_ACCOUNT}".

      11. Choose Hide passwords and secrets to mask sensitive information in consoles, command line tools, and APIs. For more information, see the NoEcho parameter documentation in Parameters in the AWS CloudFormation User Guide.

   3. To add an Amazon EKS console add-on delivery option, make sure that artifacts conform to Requirements for Amazon EKS add-on products, and then perform the following steps:

      Note

      Only one Amazon EKS add-on delivery option is supported per version. You aren't able to add a new version until the current version you're working with is published on the Amazon EKS console.

      1. In Helm chart, add the Amazon ECR URL to the Helm chart that buyers will install in their deployment environment to launch your software.

      2. In Container images, add the Amazon ECR URL to the container images that contain the product version software. Make sure that all images within the Helm chart are listed.

      3. In Delivery option title and Deployment option description, enter a title and description for this delivery option.

      4. In Visibility, keep the default value of Limited selected.

      5. In Add-on name, enter a unique name for this add-on. The add-on name that you enter will be appended with the seller’s name while being displayed in the Amazon EKS console.

      6. In Add-on version, enter the version of the add-on that will be visible when installing or upgrading this add-on. Follow the format major.minor.patch.

      7. In Add-on type, select a category for your add-on from the dropdown list.

      8. In Kubernetes Version, select all the Kubernetes versions that your add-on will support.

      9. In Architecture, select the platform architectures that your add-on supports. The options are AMD64 and ARM64. We recommend supporting both architectures to maximize compatibility. If your add-on doesn't support ARM64 devices, you must specify a planned date for adding support before your product can be published in all commercial AWS Regions.

      10. In Namespace, enter a unique Kubernetes namespace where your add-on will be installed. The default, kube-system, and kube-public namespaces aren't supported for installing third-party add-ons.

      11. In Environment Override parameters, you can select up to 2 environment parameters from the Amazon EKS add-on framework. You can map parameter names from your values.yaml to these environment variables, which are ${AWS_REGION} and ${AWS_EKS_CLUSTER_NAME}.

7. To add additional delivery options, choose New delivery option and repeat the instructions in the previous steps to configure them.

8. Choose Submit.

Step 4: Update version information

After a version is created, it can be helpful to provide updated information to your buyers by modifying the information associated with the version. For example, if you plan to restrict version 1.0 after version 1.1 is released, you can update the description of version 1.0 to direct buyers to version 1.1. Provide the date that version 1.0 will be restricted. You update the version information from the AWS Marketplace Management Portal.

To update version information

1. Sign in to the AWS Marketplace Management Portal.

2. Select Server from the Products menu.

3. On the Server products tab, select the product that you want to modify.

4. From the Request changes dropdown, choose Update version information.

5. On the Update version page, select the version that you want to update.

6. Make updates to the selected version. The fields that are available for updating depend on the status of the product version or delivery option.

   1. For all versions, you can update the Release notes.

   2. For versions that are not yet publicly available, you can update the Version title.

   3. For delivery options that haven't been restricted, you can update the following fields:

      • Description

      • Usage instructions

      • Supported services

   4. For delivery options in versions that are not yet publicly available, you can update the following fields:

      • Delivery option titles

      • Helm chart (for Helm chart delivery options only)

      • Container images

      • Deployment resources

      • AddOn Name

      • AddOn Version

      • AddOn Type

      • Helm Chart URI

      • CompatibleKubernetesVersions

      • SupportedArchitectures

      • Namespace

      • EnvironmentOverrideParameters

   5. For delivery options in versions that are publicly available, you can update SupportedArchitectures.

7. Choose Submit.

8. Verify that the request appears on the Requests tab with the Under review status.

You can check the status of your request at any time from the Requests tab of the Server Products page.

Restrict a version of your Amazon EKS add-on

To restrict a version of your container product published as an add-on, contact the AWS Marketplace operations team using the contact us form at the bottom of the AWS Marketplace Management Portal.