Commit 0d51552f authored by Pierre Smeyers's avatar Pierre Smeyers
Browse files

fix: use docker.io FQDN instead of registry.hub.docker.com

parent 427e1adb

README.md

+22 −16
Original line number Diff line number Diff line
@@ -5,16 +5,23 @@ This project allows creating a new to-be-continuous template repository from scr 
## Usage



1. Install `cookiecutter` globally (requires Python installed):



   ```bash

   pip install cookiecutter

   ```



   :information_source: for other installation options, please have a look at the [official doc](https://cookiecutter.readthedocs.io/en/stable/installation.html).



2. Run cookiecutter to create a new to-be-continuous template project:



   ```bash

   cookiecutter https://gitlab.com/to-be-continuous/tools/template-skeleton-2

   ```



   then answer the CLI questions



3. init the Git repo and share



   ```bash

   cd name-of-template

   git init .
@@ -23,4 +30,3 @@ This project allows creating a new to-be-continuous template repository from scr 
   git commit -m 'initial commit'

   git push

   ```

{{cookiecutter.project_slug}}/README.md

+3 −3
Original line number Diff line number Diff line
@@ -44,7 +44,7 @@ The {{cookiecutter.template_name}} template uses some global configuration used 


| Input / Variable      | Description                            | Default value     |

| --------------------- | -------------------------------------- | ----------------- |

| `image` / `{{cookiecutter.template_PREFIX}}_IMAGE` | The Docker image used to run `{{cookiecutter.cli_tool}}` | `registry.hub.docker.com/{{cookiecutter.project_slug}}:latest` |

| `image` / `{{cookiecutter.template_PREFIX}}_IMAGE` | The Docker image used to run `{{cookiecutter.cli_tool}}` | `docker.io/{{cookiecutter.project_slug}}:latest` |



## Jobs
@@ -365,7 +365,7 @@ The {{cookiecutter.template_name}} template uses some global configuration used 


| Input / Variable         | Description                            | Default value     |

| ------------------------ | -------------------------------------- | ----------------- |

| `image` / `{{cookiecutter.template_PREFIX}}_IMAGE`              | the Docker image used to run {{cookiecutter.template_name}} CLI commands | `registry.hub.docker.com/{{cookiecutter.project_slug}}:latest` |

| `image` / `{{cookiecutter.template_PREFIX}}_IMAGE`              | the Docker image used to run {{cookiecutter.template_name}} CLI commands | `docker.io/{{cookiecutter.project_slug}}:latest` |

| `base-app-name` / `{{cookiecutter.template_PREFIX}}_BASE_APP_NAME`      | Base application name                  | `$CI_PROJECT_NAME` ([see GitLab doc](https://docs.gitlab.com/ee/ci/variables/predefined_variables.html)) |

| `api-url` / `{{cookiecutter.template_PREFIX}}_API_URL`            | Default {{cookiecutter.template_name}} API url | _none_ |

| :lock: `{{cookiecutter.template_PREFIX}}_API_TOKEN`          | Default {{cookiecutter.template_name}} API token | _none_ |
@@ -485,7 +485,7 @@ It uses the following variable: 


| Input / Variable      | Description                              | Default value     |

| --------------------- | ---------------------------------------- | ----------------- |

| `image` / `{{cookiecutter.template_PREFIX}}_IMAGE`       | The Docker image used to run {{cookiecutter.template_name}}. | `registry.hub.docker.com/{{cookiecutter.project_slug}}:latest` |

| `image` / `{{cookiecutter.template_PREFIX}}_IMAGE`       | The Docker image used to run {{cookiecutter.template_name}}. | `docker.io/{{cookiecutter.project_slug}}:latest` |

| `project-dir` / `{{cookiecutter.template_PREFIX}}_PROJECT_DIR` | The {{cookiecutter.template_name}} project directory (containing test scripts) | `.` |

| `extra-args` / `{{cookiecutter.template_PREFIX}}_EXTRA_ARGS`  | {{cookiecutter.template_name}} extra [run options](link-to-cli-options-ref) | _none_ |

| `review-enabled` / `REVIEW_ENABLED`      | Set to `true` to enable {{cookiecutter.template_name}} tests on review environments (dynamic environments instantiated on development branches) | _none_ (disabled) |

{{cookiecutter.project_slug}}/kicker.json

+5 −5
Original line number Diff line number Diff line
@@ -11,7 +11,7 @@ 
    {

      "name": "{{cookiecutter.template_PREFIX}}_IMAGE",

      "description": "The Docker image used to run `{{cookiecutter.cli_tool}}`",

      "default": "registry.hub.docker.com/{{cookiecutter.project_slug}}:1.2.3"

      "default": "docker.io/{{cookiecutter.project_slug}}:1.2.3"

    },

    {

      "name": "{{cookiecutter.template_PREFIX}}_BUILD_ARGS",
@@ -30,7 +30,7 @@ 
        {

          "name": "{{cookiecutter.template_PREFIX}}_LINT_IMAGE",

          "description": "The Docker image used to run the lint tool",

          "default": "registry.hub.docker.com/{{cookiecutter.project_slug}}-lint:latest"

          "default": "docker.io/{{cookiecutter.project_slug}}-lint:latest"

        },

        {

          "name": "{{cookiecutter.template_PREFIX}}_LINT_ARGS",
@@ -48,7 +48,7 @@ 
        {

          "name": "{{cookiecutter.template_PREFIX}}_DEPCHECK_IMAGE",

          "description": "The Docker image used to run the dependency check tool",

          "default": "registry.hub.docker.com/{{cookiecutter.project_slug}}-depcheck:latest"

          "default": "docker.io/{{cookiecutter.project_slug}}-depcheck:latest"

        },

        {

          "name": "{{cookiecutter.template_PREFIX}}_DEPCHECK_ARGS",
@@ -95,7 +95,7 @@ 
    {

      "name": "{{cookiecutter.template_PREFIX}}_IMAGE",

      "description": "The Docker image used to run {{cookiecutter.template_name}} CLI commands - **set the version required by your {{cookiecutter.template_name}} cluster**",

      "default": "registry.hub.docker.com/{{cookiecutter.project_slug}}:latest"

      "default": "docker.io/{{cookiecutter.project_slug}}:latest"

    },

    {

      "name": "{{cookiecutter.template_PREFIX}}_API_URL",
@@ -288,7 +288,7 @@ 
    {

      "name": "{{cookiecutter.template_PREFIX}}_IMAGE",

      "description": "The Docker image used to run {{cookiecutter.template_name}}",

      "default": "registry.hub.docker.com/{{cookiecutter.project_slug}}:latest"

      "default": "docker.io/{{cookiecutter.project_slug}}:latest"

    },

    {

      "name": "{{cookiecutter.template_PREFIX}}_PROJECT_DIR",

{{cookiecutter.project_slug}}/templates/gitlab-ci-{{cookiecutter.project_slug}}.yml

+5 −5
Original line number Diff line number Diff line
@@ -18,7 +18,7 @@ spec: 
{% if cookiecutter.template_type == 'build' %}

    image:

      description: The Docker image used to run `{{cookiecutter.cli_tool}}`

      default: registry.hub.docker.com/{{cookiecutter.project_slug}}:1.2.3

      default: docker.io/{{cookiecutter.project_slug}}:1.2.3

    build-args:

      description: Arguments used by the build job

      default: build --with-default-args
@@ -28,13 +28,13 @@ spec: 
      default: false

    lint-image:

      description: The Docker image used to run the lint tool

      default: registry.hub.docker.com/{{cookiecutter.project_slug}}-lint:latest

      default: docker.io/{{cookiecutter.project_slug}}-lint:latest

    lint-args:

      description: Lint [options and arguments](link-to-the-cli-options)

      default: --serevity=medium

    depcheck-image:

      description: The Docker image used to run the dependency check tool

      default: registry.hub.docker.com/{{cookiecutter.project_slug}}-depcheck:latest

      default: docker.io/{{cookiecutter.project_slug}}-depcheck:latest

    depcheck-args:

      description: Dependency check [options and arguments](link-to-the-cli-options)

      default: ''
@@ -48,7 +48,7 @@ spec: 
{%- elif cookiecutter.template_type == 'acceptance' %}

    image:

      description: The Docker image used to run {{cookiecutter.template_name}}

      default: registry.hub.docker.com/{{cookiecutter.project_slug}}:latest

      default: docker.io/{{cookiecutter.project_slug}}:latest

    project-dir:

      description: The {{cookiecutter.template_name}} project directory (containing test scripts)

      default: .
@@ -62,7 +62,7 @@ spec: 
{%- elif cookiecutter.template_type == 'deploy' %}

    image:

      description: The Docker image used to run {{cookiecutter.template_name}} CLI commands - **set the version required by your {{cookiecutter.template_name}} cluster**

      default: registry.hub.docker.com/{{cookiecutter.project_slug}}:latest

      default: docker.io/{{cookiecutter.project_slug}}:latest

    api-url:

      description: Default {{cookiecutter.template_name}} API url

      default: ''