Skip to content

Latest commit

 

History

History
35 lines (28 loc) · 2.02 KB

CONTRIBUTING.md

File metadata and controls

35 lines (28 loc) · 2.02 KB
Raw

Contributing

Requirement: Your application must be deployable via Helm 3

To add your application to the DigitalOcean Marketplace, you'll need to do the following:

  1. Ensure that you have Helm 3 installed on your machine. Instructions
  2. Add a Helm 3 deployment (deploy.sh) file to this repo.
  3. Get an account set up within the DigitalOcean Marketplace Vendor Portal

Adding Your Application

  1. Clone or fork the digitalocean/marketplace-kubernetes repository
  2. Create a git branch that includes the name of your app (example: $APP_NAME-first-pr)
  3. Run the following commands to create your deploy.sh and values.yml files. They will be located in stacks/$APP_NAME:
export HELM_REPO_NAME=stable
export HELM_REPO_URL=https://kubernetes-charts.storage.googleapis.com/
export STACK_NAME=$APP_NAME
export CHART_NAME=$APP_NAME/$APP_NAME
export CHART_VERSION=1.0.0
export NAMESPACE=$APP_NAME

./utils/generate-stack.sh
  1. Optionally, customize your deploy.sh and specify your Helm chart's configuration values in values.yml. Both can be found in stacks/$APP_NAME
  2. Test out your stack by deploying it locally to a k8s cluster: ./stacks/$APP_NAME/deploy.sh
  3. Open a PR

Updating Your Application

  1. To deploy a newer version of your app's Helm chart, simply update the CHART_VERSION value in your stacks/$APP_NAME/deploy.sh file. If necessary, update your values.yml as well.
  2. Open a PR
  3. Once your PR is merged, make the necessary listing copy updates in the Vendor Portal. The changes you make there will be reflected within your Marketplace listing.

Getting Vendor Portal Access

Email [email protected] to get access to the Marketplace Vendor Portal. This is where you will manage your application's listing page.