Skip to content
Snippets Groups Projects
kicker.json 5.91 KiB
Newer Older
Pierre Smeyers's avatar
Pierre Smeyers committed
{
  "name": "Google Cloud",
  "description": "Deploy your code to an [Google Cloud](https://www.gcloud.com/) environment",
  "template_path": "templates/gitlab-ci-gcloud.yml",
  "kind": "hosting",
  "variables": [
    {
      "name": "GCP_CLI_IMAGE",
      "description": "The Docker image used to run Google Cloud CLI commands",
      "default": "google/cloud-sdk:latest"
    },
    {
      "name": "GCP_KEY_FILE",
      "description": "Global Service Account key file",
      "secret": true,
      "mandatory": true
    },
    {
      "name": "GCP_BASE_APP_NAME",
      "description": "Base application name",
      "default": "$CI_PROJECT_NAME",
      "advanced": true
    },
    {
      "name": "GCP_SCRIPTS_DIR",
      "description": "Directory where Google Cloud scripts (deploy & cleanup) are located",
      "default": ".",
      "advanced": true
    }
  ],
  "features": [
    {
      "id": "review",
      "name": "Review",
      "description": "Dynamic review environments for your topic branches (see GitLab [Review Apps](https://docs.gitlab.com/ee/ci/review_apps/))",
      "variables": [
        {
          "name": "GCP_REVIEW_PROJECT",
          "description": "Google Cloud project ID for review env",
          "mandatory": true
        },
        {
          "name": "GCP_REVIEW_APP_NAME",
          "description": "The application name for review env (only define if different from global)",
          "advanced": true
        },
        {
          "name": "GCP_REVIEW_ENVIRONMENT_SCHEME",
          "description": "The review environment protocol scheme",
          "default": "https"
Pierre Smeyers's avatar
Pierre Smeyers committed
        },
        {
          "name": "GCP_REVIEW_ENVIRONMENT_DOMAIN",
          "description": "The review environment domain (ex: `noprod-gcloud.domain.com`).\n\nRequired for static environment URLs declaration only (see doc).\n\nBy default review `environment.url` will be built as `${GCP_REVIEW_ENVIRONMENT_SCHEME}://${$CI_PROJECT_NAME}-${CI_ENVIRONMENT_SLUG}.${GCP_REVIEW_ENVIRONMENT_DOMAIN}`"
Pierre Smeyers's avatar
Pierre Smeyers committed
        },
        {
          "name": "GCP_REVIEW_KEY_FILE",
          "description": "Service Account key file to authenticate on review env (only define if different from global)",
          "secret": true
        }
      ]
    },
    {
      "id": "integration",
      "name": "Integration",
      "description": "A continuous-integration environment associated to your integration branch (`develop` by default)",
      "variables": [
        {
          "name": "GCP_INTEG_PROJECT",
          "description": "Google Cloud project ID for integration env",
          "mandatory": true
        },
        {
          "name": "GCP_INTEG_APP_NAME",
          "description": "The application name for integration env (only define if different from global)",
          "advanced": true
        },
        {
          "name": "GCP_INTEG_ENVIRONMENT_URL",
          "type": "url",
          "description": "The integration environment url including scheme (ex: `https://my-application-integration.noprod-gcloud.domain.com`).\n\nRequired for static environment URLs declaration only (see doc).\n\nDo not use variable inside variable definition as it will result in a two level cascade variable and gitlab does not allow that."
Pierre Smeyers's avatar
Pierre Smeyers committed
        },
        {
          "name": "GCP_INTEG_KEY_FILE",
          "description": "Service Account key file to authenticate on integration env (only define if different from global)",
          "secret": true
        }
      ]
    },
    {
      "id": "staging",
      "name": "Staging",
      "description": "An iso-prod environment meant for testing and validation purpose on your production branch (`master` by default)",
      "variables": [
        {
          "name": "GCP_STAGING_PROJECT",
          "description": "Google Cloud project ID for staging env",
          "mandatory": true
        },
        {
          "name": "GCP_STAGING_APP_NAME",
          "description": "The application name for staging env (only define if different from global)",
          "advanced": true
        },
        {
          "name": "GCP_STAGING_ENVIRONMENT_URL",
          "type": "url",
          "description": "The staging environment url including scheme (ex: `https://my-application-staging.noprod-gcloud.domain.com`).\n\nRequired for static environment URLs declaration only (see doc).\n\nDo not use variable inside variable definition as it will result in a two level cascade variable and gitlab does not allow that."
Pierre Smeyers's avatar
Pierre Smeyers committed
        },
        {
          "name": "GCP_STAGING_KEY_FILE",
          "description": "Service Account key file to authenticate on staging env (only define if different from global)",
          "secret": true
        }
      ]
    },
    {
      "id": "prod",
      "name": "Production",
      "description": "The production environment",
      "variables": [
        {
          "name": "GCP_PROD_PROJECT",
          "description": "Google Cloud project ID for production env",
          "mandatory": true
        },
        {
          "name": "GCP_PROD_APP_NAME",
          "description": "The application name for production env (only define if different from global)",
          "advanced": true
        },
        {
          "name": "GCP_PROD_ENVIRONMENT_URL",
          "type": "url",
          "description": "The production environment url including scheme (ex: `https://my-application.gcloud.domain.com`).\n\nRequired for static environment URLs declaration only (see doc).\n\nDo not use variable inside variable definition as it will result in a two level cascade variable and gitlab does not allow that."
Pierre Smeyers's avatar
Pierre Smeyers committed
        },
        {
          "name": "AUTODEPLOY_TO_PROD",
          "type": "boolean",
          "description": "Set this variable to auto-deploy to production. If not set deployment to production will be manual (default behaviour)."
        },
        {
          "name": "GCP_PROD_KEY_FILE",
          "description": "Service Account key file to authenticate on production env (only define if different from global)",
          "secret": true
        }
      ]
    }
  ]
}