diff --git a/doc/administration/dedicated/configure_instance.md b/doc/administration/dedicated/configure_instance.md index d638ce425230db03580fd1ead05bd608807ba3a3..2d327a96bd7df678eb1aa658c3cd5f392920f5b5 100644 --- a/doc/administration/dedicated/configure_instance.md +++ b/doc/administration/dedicated/configure_instance.md @@ -82,10 +82,37 @@ To view the configuration change log: 1. Select your tenant. 1. At the top of the page, select **Configuration change log**. -### Bring your own domain +### Bring your own domain (BYOD) You can add a [custom hostname](../../subscriptions/gitlab_dedicated/index.md#bring-your-own-domain) for your GitLab Dedicated instance. Optionally, you can also provide a custom hostname for the bundled container registry and KAS services. +Prerequisites: + +- Access to your domain's server control panel to set up DNS records. + +#### Set up DNS records + +Custom domains require a: + +- `CNAME` record: Add a `CNAME` record that points your custom hostname to `tenant_name.gitlab-dedicated.com`. + + ```plaintext + gitlab.my-company.com. CNAME tenant_name.gitlab-dedicated.com + ``` + +- `CAA` record: If your domain has an existing `CAA` (Certification Authority Authorization) record, [add a `CAA` record for Let's Encrypt](https://letsencrypt.org/docs/caa/). This allows Let's Encrypt to also issue certificates for your domain. + + ```plaintext + example.com. IN CAA 0 issue "pki.goog" + example.com. IN CAA 0 issue "letsencrypt.org" + ``` + + In this example, the `CAA` record defines Google Trust Services (`"pki.goog"`) and Let's Encrypt (`"letsencrypt.org"`) as certificate authorities that are allowed to issue certificates for your domain. + +#### Add a custom hostname + +You can add a custom hostname when you [create your tenant](../../administration/dedicated/create_instance.md#step-2-create-your-gitlab-dedicated-instance). + To add a custom hostname after your instance is created, submit a [support ticket](https://support.gitlab.com/hc/en-us/requests/new?ticket_form_id=4414917877650). ### SMTP email service diff --git a/doc/administration/dedicated/create_instance.md b/doc/administration/dedicated/create_instance.md index 8bee30df0b6b426720ed127113bfe35822a6f4a9..6851622e84da30aec7bb26eb1377151e49cfc230 100644 --- a/doc/administration/dedicated/create_instance.md +++ b/doc/administration/dedicated/create_instance.md @@ -181,7 +181,7 @@ information required to create your GitLab Dedicated instance. 1. Optional. Security: You can provide your own [KMS keys](https://docs.aws.amazon.com/kms/latest/developerguide/overview.html) for encrypted AWS services. If you choose not to provide KMS keys, encryption keys are generated for your instance when it is created. For more information, see [encrypting your data at rest](#encrypted-data-at-rest-byok). -1. Optional. Bring Your Own Domain: You can add a custom hostname for your GitLab Dedicated instance, the bundled container registry, and KAS services. +1. Optional. [Bring Your Own Domain](../../administration/dedicated/configure_instance.md#bring-your-own-domain-byod): You can add a custom hostname for your GitLab Dedicated instance, the bundled container registry, and KAS services. 1. Summary: Confirm that the information you've provided in the previous steps is accurate before initiating the creation of your instance. @@ -203,6 +203,7 @@ Also plan ahead if you need the following features: - [Inbound Private Link](../../administration/dedicated/configure_instance.md#inbound-private-link) - [Outbound Private Link](../../administration/dedicated/configure_instance.md#outbound-private-link) - [SAML SSO](../../administration/dedicated/configure_instance.md#saml) +- [Bring your own domain](../../administration/dedicated/configure_instance.md#bring-your-own-domain-byod) ## Things to know