Setting up your Google Cloud environment

This page describes the steps to set up your Google Cloud environment so that you can distribute your Kubernetes apps.

Creating your workspace

We recommend that you create a new project in the Google Cloud console primarily for your Cloud Marketplace products.

To manage products that you submit to Cloud Marketplace, we recommend that you create a new project with a project ID ending in -public. To create a project for your products, see Creating and managing projects.

If you already have a project set up to sell on Cloud Marketplace that you want to use, verify that the roles are granted correctly for Kubernetes, and skip to setting up a container registry.

After you create your project, grant the following roles at the project level:

  • The Project Editor and Service Management Administrator roles to

  • The Service Management Administrator role to

  • The Config Editor (roles/servicemanagement.configEditor) role to

For steps to grant access to your project, see Granting, changing and revoking access to resources.

After you've granted project level roles, grant the following roles at the service level:

  • The Service Consumer role (roles/servicemanagement.serviceConsumer) and Service Controller role (roles/servicemanagement.serviceController), to

For steps to grant access at the service level, see Granting and revoking access to the API.

After you have created the project, complete the Project Info form that the Cloud Marketplace team gives you.

Set up a container registry

You need a Container Registry repository to host the container images for your app. Artifact Analysis continuously scans the app images for vulnerabilities so that you can review and address issues before submitting your product to Cloud Marketplace.

To set up Container Registry, Docker, and the Google Cloud SDK, follow the Container Registry quickstart.

After you set up Container Registry, in the project that contains your registry, grant the Project Viewer role to

Enable the Container Analysis API

You must enable the Artifact Analysis API, which scans your container images in Container Registry for vulnerabilities. For an overview of vulnerability scanning in Artifact Analysis, see see the Container Registry Documentation.

Add your product to Cloud Marketplace

To create and publish your product in Cloud Marketplace, you use Producer Portal. Your Partner Engineer enables it for you after you complete the Cloud Marketplace Project Info Form.

To publish your product in Producer Portal, you create an entry for your product, and then you submit the following information for review:

  • Product details: Add listing and marketing information about your product.
  • Pricing: Choose and specify your pricing model to determine how customers pay you for your product.
  • Container images: Provide the Google Container Registry repository that includes your container images.
  • Open Source Compliance: Ensure that your product complies with Google's policies for open source software.

You can submit these reviews at any time and in any order. Some reviews might take up to two weeks for approval, so we recommend reviewing the requirements and getting started as early as possible.

To create your product's Cloud Marketplace entry:

  1. Open Producer Portal in the Google Cloud console:

    Replace YOUR_PUBLIC_PROJECT_ID with the ID for the public project that you created for Cloud Marketplace—for example, my-organization-public.

  2. At the top of the page, click Add product.

  3. Select Kubernetes.

  4. Under Product name, name your product and check the Product ID. The Product ID is used in the URL for your Cloud Marketplace listing.

  5. Click Create. It might take a few seconds to create your product.

You add your pricing model and marketing information for your solution in later steps.

Create a development cluster in Kubernetes Engine

You use Google Kubernetes Engine to manage and scale Kubernetes clusters. To create a test cluster and deploy a basic app to it, follow the Google Kubernetes Engine quickstart.

Install the mpdev development tool

The mpdev tool is a container that bundles utilities to test and publish your app images. While installing mpdev is not required to submit an app for release, you can run mpdev to verify your development environment, and to test whether your app installs correctly on your development cluster.

Install mpdev from the Cloud Marketplace tools GitHub repository.

For information on using mpdev to check your environment and test your app, see the mpdev reference on GitHub.

Organizing your releases

In general, every version of your app must adopt Semantic Versioning 2.0, which follows the MAJOR.MINOR.PATCH numbering convention. Every version must have a unique version number, such as 1.0.1, 1.0.2, 1.3.1, and so on. Optionally, add a hyphen after the version number to add a pre-release modifier, such as 1.3.1-alpha201910. Pre-release modifiers can be used to store and highlight any additional information that you find useful, such as build dates denoting when versions were created.

We recommend that you release your software in tracks. Each track is a series of versions with backwards-compatible updates. Your release tracks should be based on a minor version, such as 4.1.x. As a best practice, avoid using generic version names such as latest.

For example, if you're releasing version 2.0 of your software on Cloud Marketplace, and expect that versions 2.0.1, 2.0.5, and so on will be backwards-compatible with 2.0, organize these releases under the 2.0 release track.

When you release a backwards-incompatible version of your app, or a version that requires users to go through manual migration steps, release it on a new track, so that users can plan their updates.

Choose your product identifiers

You must select the following identifiers for your company, product, and container images, which are used to create your Cloud Marketplace URLs, and the URIs for your container images:

  • Your company's name. For example, if the name of your company is Examplesoft Inc., you can use the identifier examplesoft.

  • Your product's name. For example, if the product's name is Example Pro, use the identifier example-pro.

  • The release track of your product, such as 4.0.

    See the requirements for organizing your releases.

  • Your container images. Select a unique identifier for each container image in your app. The following identifiers are required for all apps:

    • The primary image: This container image is the main image for your product, and uses the same identifier as the product. For example, if your product identifier is example-pro, the primary image uses the same identifier.
    • deployer: The deployment container image for the track. The deployment container runs when users deploy your app from Google Cloud console You create a deployment image when you create your app package.

For example, the company Examplesoft Inc. chooses the following identifiers for their product, Example Pro:

Name Identifier
Company Examplesoft Inc examplesoft
Product Example Pro example-pro
Image [1] (primary) Example Pro server n/a
Image [2] Example Queue example-queue
Image [deployer] n/a deployer
Release track [1] Version 4.x.x 4.0
Release track [2] Version 5.x.x 5.0

For these identifiers, the following information is automatically generated:

  • The product URL in Cloud Marketplace:

  • The container image URIs: