Commit 42d4f3c3 authored by Clement Bois's avatar Clement Bois
Browse files

feat: tracking image disabled by default

parent 9a654a5a

docs/dev/guidelines.md

+1 −1
Original line number Diff line number Diff line
@@ -61,7 +61,7 @@ that defines: 
      image: $XXX_IMAGE

      services:

        # this image performs usage tracking

        - name: "registry.gitlab.com/to-be-continuous/tools/tracking:master"

        - name: "$TBC_TRACKING_IMAGE"

          command: ["--service", "xxx", "1.0.0"] # 2nd arg: template name; 3rd arg: template version 

      # Cache downloaded dependencies and plugins between builds.

      # To keep cache across branches add 'key: "$CI_JOB_NAME"'

docs/faq.md

+1 −1
Original line number Diff line number Diff line
@@ -64,6 +64,6 @@ The GitLab pipeline code is written in YAML - general-purpose markup language - 
Short answer: no you can relax, your usage is not tracked.



The tracking image is a general mechanism supported by _to-be-continuous_ to allow companies to track TBC usage **on their self-managed GitLab instances**.

It is disabled (by configuration) on gitlab.com, and may be enabled on self-managed instances, for instance to measure CI/CD and DevOps good practices adoption.

It is fully disabled by default, and may be enabled on self-managed instances, for instance to measure CI/CD and DevOps good practices adoption.



[More information in our documentation](./self-managed/advanced.md#setup-tracking).

docs/self-managed/advanced.md

+1 −5
Original line number Diff line number Diff line
@@ -239,10 +239,6 @@ define the `TRACKING_CONFIGURATION` CI/CD project variable as follows: 
    * value: `$CI_REGISTRY/to-be-continuous/tools/tracking:master` (adapt the path if you've [installed TBC in a custom root group](#installing-tbc-in-a-custom-group))<br/>

    _This will override the default tracking image used by all TBC templates_



## Disable tracking



If you don't use it at all, you can disable tracking by setting `$TBC_TRACKING_IMAGE` to empty.



## Use custom service images



Apart from the tracking image (see [previous chapter](#setup-tracking)), TBC also uses a couple of extra service images.
@@ -257,7 +253,7 @@ Here are the service images used by TBC templates: 


| Project | Description | Image variable |

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

| [tools/tracking](https://gitlab.com/to-be-continuous/tools/tracking) | This image can be used to collect statistics about template jobs execution.<br/>**Used by all TBC templates.** | `TBC_TRACKING_IMAGE` |

| [tools/tracking](https://gitlab.com/to-be-continuous/tools/tracking) | This image can be used to collect statistics about template jobs execution. | `TBC_TRACKING_IMAGE` |

| [tools/vault-secrets-provider](https://gitlab.com/to-be-continuous/tools/vault-secrets-provider) | This image can be used to retrieve secrets from a [Vault](https://www.vaultproject.io/) server.<br/>Used by TBC Vault variants. | `TBC_VAULT_IMAGE` |

| [tools/aws-auth-provider](https://gitlab.com/to-be-continuous/tools/aws-auth-provider) | This image can be used to retrieve an authorization token for AWS.<br/>Used by TBC AWS variants. | `TBC_AWS_PROVIDER_IMAGE` |

| [tools/gcp-auth-provider](https://gitlab.com/to-be-continuous/tools/gcp-auth-provider) | This image can be used to retrieve an access token for GCP.<br/>Used by TBC GCP variants. | `TBC_GCP_PROVIDER_IMAGE` |

docs/self-managed/basic.md

+1 −1
Original line number Diff line number Diff line
@@ -54,7 +54,7 @@ That should take a while, but hopefully at the end you'll have cloned the comple 
    _to be continuous_ used to need the [tracking](https://gitlab.com/to-be-continuous/tools/tracking) Docker image to be successfully built and available locally in your

    Docker registry because it is used as a [service container](https://docs.gitlab.com/ee/ci/services/) by all templates.



    This is no longer required as in its latest versions, TBC is - by default - pulling the image [from the gitlab.com public registry](https://gitlab.com/to-be-continuous/tools/tracking/container_registry).

    This is no longer required as in its latest versions, TBC - by default - is not pulling the image anymore.



    This can be overridden. For more info, please [read the advanced usage chapter](./advanced.md#setup-tracking).