Commit c4789d0a authored by Pierre Smeyers's avatar Pierre Smeyers
Browse files

Merge branch '18-auto-stop-environments' into 'master' 

Resolve "auto-stop environments"

Closes #18

See merge request to-be-continuous/openshift!49
parents ecc6c53a 08d32f5f

README.md

+1 −2
Original line number Diff line number Diff line
@@ -384,8 +384,7 @@ Here are variables supported to configure review environments: 
| :lock: `OS_REVIEW_TOKEN` | OpenShift API [token](#supported-authentication-methods) for `review` env  _(only define if different from default)_    | `$OS_TOKEN` |

| `OS_REVIEW_APP_NAME`     | Application name for `review` env      | `"${OS_BASE_APP_NAME}-${CI_ENVIRONMENT_SLUG}"` (ex: `myproject-review-fix-bug-12`) |

| `OS_REVIEW_ENVIRONMENT_URL`| The review environments url _(only define for static environment URLs declaration and if different from default)_ | `$OS_ENVIRONMENT_URL` |



Note: By default, review `environment.url` will be built as `${OS_REVIEW_ENVIRONMENT_SCHEME}://${$CI_PROJECT_NAME}-${CI_ENVIRONMENT_SLUG}.${OS_REVIEW_ENVIRONMENT_DOMAIN}`

| `OS_REVIEW_AUTOSTOP_DURATION`| The amount of time before GitLab will automatically stop `review` environments | `4 hours` |



### Integration environment configuration

kicker.json

+5 −0
Original line number Diff line number Diff line
@@ -67,6 +67,11 @@ 
          "description": "The application name for review env (only define if different from global)",

          "advanced": true

        },

        {

          "name": "OS_REVIEW_AUTOSTOP_DURATION",

          "description": "The amount of time before GitLab will automatically stop `review` environments",

          "default": "4 hours"

        },

        {

          "name": "OS_REVIEW_ENVIRONMENT_URL",

          "type": "url",

templates/gitlab-ci-openshift.yml

+26 −33
Original line number Diff line number Diff line
@@ -57,7 +57,9 @@ variables: 
  OS_BASE_APP_NAME: "$CI_PROJECT_NAME"

  OS_SCRIPTS_DIR: "."

  OS_BASE_TEMPLATE_NAME: "openshift"

  # deprecated, backward compatibility

  OS_REVIEW_ENVIRONMENT_SCHEME: "https"

  OS_REVIEW_AUTOSTOP_DURATION: "4 hours"

  OS_CLEANUP_OBJECT_TYPES: "all,pvc,configmap,secret"



  # default: one-click deploy
@@ -368,15 +370,15 @@ stages: 
    fi

  }



  function deploy() {

  function os_deploy() {

     # export project as it may be usefull to build image name based on internal registry (ex: docker-registry.default.svc:5000/${project}/${DOCKER_IMAGE_NAME}:${DOCKER_IMAGE_LABEL} )

    project=$(oc project -q)

    export project

    export environment_type=$1

    export environment_name=$2

    environment_url=$3

    export environment_type=$ENV_TYPE

    export environment_name=${ENV_APP_NAME:-${OS_BASE_APP_NAME}${ENV_APP_SUFFIX}}

    environment_url=${ENV_URL:-${OS_ENVIRONMENT_URL:-$ENV_URL_LEGACY}}

    # also export environment_name in SCREAMING_SNAKE_CASE format (may be useful with OpenShift env variables)

    environment_name_ssc=$(to_ssc "$2")

    environment_name_ssc=$(to_ssc "$environment_name")

    export environment_name_ssc



    # backward compatibility
@@ -503,11 +505,11 @@ stages: 
    esac

  }



  function delete() {

    export environment_type=$1

    export environment_name=$2

  function os_delete() {

    export environment_type=$ENV_TYPE

    export environment_name=${ENV_APP_NAME:-${OS_BASE_APP_NAME}${ENV_APP_SUFFIX}}

    # also export environment_name in SCREAMING_SNAKE_CASE format (may be useful with OpenShift env variables)

    environment_name_ssc=$(to_ssc "$2")

    environment_name_ssc=$(to_ssc "$environment_name")

    export environment_name_ssc



    # backward compatibility
@@ -623,6 +625,10 @@ stages: 
  before_script:

    - *os-scripts

    - install_ca_certs "${CUSTOM_CA_CERTS:-$DEFAULT_CA_CERTS}"

    - assert_defined "${ENV_API_URL:-$OS_URL}" 'Missing required OpenShift url'

    - assert_defined "${ENV_TOKEN:-$OS_TOKEN}" 'Missing required OpenShift token'

    - assert_defined "$ENV_PROJECT" 'Missing required OpenShift project'

    - oc login "${ENV_API_URL:-$OS_URL}" --token="${ENV_TOKEN:-$OS_TOKEN}" -n "$ENV_PROJECT"



# Deploy job prototype

# Can be extended to define a concrete environment
@@ -639,15 +645,8 @@ stages: 
  stage: deploy

  variables:

    ENV_APP_SUFFIX: "-$CI_ENVIRONMENT_SLUG"

  before_script:

    - *os-scripts

    - install_ca_certs "${CUSTOM_CA_CERTS:-$DEFAULT_CA_CERTS}"

    - assert_defined "${ENV_API_URL:-$OS_URL}" 'Missing required OpenShift url'

    - assert_defined "${ENV_TOKEN:-$OS_TOKEN}" 'Missing required OpenShift token'

    - assert_defined "$ENV_PROJECT" 'Missing required OpenShift project'

    - oc login ${ENV_API_URL:-$OS_URL} --token=${ENV_TOKEN:-$OS_TOKEN} -n $ENV_PROJECT

  script:

    - deploy "$ENV_TYPE" "${ENV_APP_NAME:-${OS_BASE_APP_NAME}${ENV_APP_SUFFIX}}" "${ENV_URL:-${OS_ENVIRONMENT_URL:-$ENV_URL_LEGACY}}"

    - os_deploy

  artifacts:

    name: "$ENV_TYPE env url for $CI_PROJECT_NAME on $CI_COMMIT_REF_SLUG"

    paths:
@@ -673,19 +672,11 @@ stages: 
  dependencies: []

  variables:

    ENV_APP_SUFFIX: "-$CI_ENVIRONMENT_SLUG"

  before_script:

    - *os-scripts

    - install_ca_certs "${CUSTOM_CA_CERTS:-$DEFAULT_CA_CERTS}"

    - assert_defined "${ENV_API_URL:-$OS_URL}" 'Missing required OpenShift url'

    - assert_defined "${ENV_TOKEN:-$OS_TOKEN}" 'Missing required OpenShift token'

    - assert_defined "$ENV_PROJECT" 'Missing required OpenShift project'

    - oc login ${ENV_API_URL:-$OS_URL} --token=${ENV_TOKEN:-$OS_TOKEN} -n $ENV_PROJECT

  script:

    - delete "$ENV_TYPE" "${ENV_APP_NAME:-${OS_BASE_APP_NAME}${ENV_APP_SUFFIX}}"

    - os_delete

  environment:

    action: stop





# deploy to review env (only for branches)

# disabled by default, enable this job by setting

# $OS_REVIEW_PROJECT.
@@ -695,6 +686,7 @@ os-review: 
    ENV_TYPE: review

    ENV_APP_NAME: "$OS_REVIEW_APP_NAME"

    ENV_URL: "${OS_REVIEW_ENVIRONMENT_URL}"

    # deprecated, backward compatibility

    ENV_URL_LEGACY: "${OS_REVIEW_ENVIRONMENT_SCHEME}://${CI_PROJECT_NAME}-${CI_ENVIRONMENT_SLUG}.${OS_REVIEW_ENVIRONMENT_DOMAIN}"

    ENV_API_URL: "$OS_REVIEW_URL"

    ENV_TOKEN: "$OS_REVIEW_TOKEN"
@@ -702,6 +694,7 @@ os-review: 
  environment:

    name: review/$CI_COMMIT_REF_NAME

    on_stop: os-cleanup-review

    auto_stop_in: "$OS_REVIEW_AUTOSTOP_DURATION"

  resource_group: review/$CI_COMMIT_REF_NAME

  rules:

    # exclude tags
@@ -741,14 +734,14 @@ os-cleanup-review: 
# stop all review envs (manual job on master branch)

os-cleanup-all-review:

  extends: .os-base

  variables:

    ENV_TYPE: review

    ENV_APP_NAME: "$OS_REVIEW_APP_NAME"

    ENV_API_URL: "$OS_REVIEW_URL"

    ENV_TOKEN: "$OS_REVIEW_TOKEN"

    ENV_PROJECT: "$OS_REVIEW_PROJECT"

  stage: deploy

  dependencies: []

  before_script:

    - *os-scripts

    - install_ca_certs "${CUSTOM_CA_CERTS:-$DEFAULT_CA_CERTS}"

    - assert_defined "${OS_REVIEW_URL:-$OS_URL}" 'Missing required env $OS_REVIEW_URL or $OS_URL'

    - assert_defined "${OS_REVIEW_TOKEN:-$OS_TOKEN}" 'Missing required env $OS_REVIEW_TOKEN or $OS_TOKEN'

    - oc login ${OS_REVIEW_URL:-$OS_URL} --token=${OS_REVIEW_TOKEN:-$OS_TOKEN} -n $OS_REVIEW_PROJECT

  script:

    - delete_all review "${OS_REVIEW_APP_NAME:-${OS_BASE_APP_NAME}-review-.*}"

  rules: