From 0d1296e42d02b42684c7fd4165e1dc5fcf61f546 Mon Sep 17 00:00:00 2001 From: Timo Furrer <tfurrer@gitlab.com> Date: Wed, 15 May 2024 07:21:15 +0200 Subject: [PATCH] Improve self-managed mirror docs in README --- .gitlab/README.md.template | 13 +++---------- README.md | 13 +++---------- 2 files changed, 6 insertions(+), 20 deletions(-) diff --git a/.gitlab/README.md.template b/.gitlab/README.md.template index f090138..03983f9 100644 --- a/.gitlab/README.md.template +++ b/.gitlab/README.md.template @@ -266,21 +266,14 @@ It's also not possible to just include CI/CD components across instance, thus an self-managed instance. However, you could mirror this project from GitLab.com onto any self-managed instance using a [repository pull mirror](https://docs.gitlab.com/ee/user/project/repository/mirror/pull.html). -and then use the component as you would from GitLab.com, but change the domain, like so: -```yaml -include: - - component: $CI_SERVER_FQDN/$CI_PROJECT_PATH/full-pipeline@<VERSION> - inputs: - ... -``` - -This example assumes your GitLab instance is hosted on `gitlab.example.com` and this component -project is mirrored in the `components/opentofu` project. If the component is being mirrored to another path than `components/opentofu`, then you also need to change that path in the `include:component` and additionally provide the correct `image_registry_base` input. +See also the official GitLab documentation for it +[here](https://docs.gitlab.com/ee/ci/components/#use-a-gitlabcom-component-in-a-self-managed-instance). + ## Migrating from the Terraform CI/CD templates When migrating from the GitLab Terraform CI/CD templates you can use the following migration rules: diff --git a/README.md b/README.md index 7255c01..a6f8592 100644 --- a/README.md +++ b/README.md @@ -291,21 +291,14 @@ It's also not possible to just include CI/CD components across instance, thus an self-managed instance. However, you could mirror this project from GitLab.com onto any self-managed instance using a [repository pull mirror](https://docs.gitlab.com/ee/user/project/repository/mirror/pull.html). -and then use the component as you would from GitLab.com, but change the domain, like so: -```yaml -include: - - component: $CI_SERVER_FQDN/$CI_PROJECT_PATH/full-pipeline@<VERSION> - inputs: - ... -``` - -This example assumes your GitLab instance is hosted on `gitlab.example.com` and this component -project is mirrored in the `components/opentofu` project. If the component is being mirrored to another path than `components/opentofu`, then you also need to change that path in the `include:component` and additionally provide the correct `image_registry_base` input. +See also the official GitLab documentation for it +[here](https://docs.gitlab.com/ee/ci/components/#use-a-gitlabcom-component-in-a-self-managed-instance). + ## Migrating from the Terraform CI/CD templates When migrating from the GitLab Terraform CI/CD templates you can use the following migration rules: -- GitLab