From 1965fc2d257e4c5b3b049f7eb4839823d76d91e3 Mon Sep 17 00:00:00 2001 From: ngala Date: Thu, 4 Apr 2024 00:48:41 -0400 Subject: [PATCH 1/3] Update status of namespace in URL path to Beta from Experiment Related: https://gitlab.com/gitlab-org/gitlab/-/issues/17584+ Changelog: other --- doc/administration/pages/index.md | 39 +++++++++++++++++++------------ 1 file changed, 24 insertions(+), 15 deletions(-) diff --git a/doc/administration/pages/index.md b/doc/administration/pages/index.md index cec336e756e6d2..5feae0f56f5e53 100644 --- a/doc/administration/pages/index.md +++ b/doc/administration/pages/index.md @@ -100,9 +100,10 @@ IPv6 address. If you don't have IPv6, you can omit the `AAAA` record. #### For namespace in URL path, without wildcard DNS DETAILS: -**Status:** Experiment +**Status:** Beta -> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/17584) in GitLab 16.7. This feature is an [Experiment](../../policy/experiment-beta-support.md). +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/17584) in GitLab 16.7 as an [Experiment](../../policy/experiment-beta-support.md). +> - Available as [Beta](../../policy/experiment-beta-support.md) in GitLab 16.11. FLAG: On self-managed GitLab, by default this feature is available. @@ -112,29 +113,35 @@ This feature is not ready for production use. Prerequisites: - Your instance must use the Linux package installation method. +- Your Linux package installation should use default `auth_redirect_uri` for GitLab Pages. If you need support for namespace in the URL path to remove the requirement for wildcard DNS: 1. Enable the GitLab Pages flag for this feature by adding `gitlab_pages["namespace_in_path"] = true` to `/etc/gitlab/gitlab.rb`. -1. In your DNS provider, add entries for `example.com` and `projects.example.com`. - In both lines, replace `example.com` with your domain name, and `192.0.0.0` with +1. In your DNS provider, add entries for `example.io` and `projects.example.io`. + In both lines, replace `example.io` with your domain name, and `192.0.0.0` with the IPv4 version of your IP address. The entries look like this: ```plaintext - example.com 1800 IN A 192.0.0.0 - projects.example.com 1800 IN A 192.0.0.0 + example.io 1800 IN A 192.0.0.0 + projects.example.io 1800 IN A 192.0.0.0 ``` 1. Optional. If your GitLab instance has an IPv6 address, add entries for it. - In both lines, replace `example.com` with your domain name, and `2001:db8::1` with + In both lines, replace `example.io` with your domain name, and `2001:db8::1` with the IPv6 version of your IP address. The entries look like this: ```plaintext - example.com 1800 IN AAAA 2001:db8::1 - projects.example.com 1800 IN AAAA 2001:db8::1 + example.io 1800 IN AAAA 2001:db8::1 + projects.example.io 1800 IN AAAA 2001:db8::1 ``` +This example contains the following: + +- `example.io`: The domain GitLab Pages is served from. +- `projects.example.io`: An additional subdomain for GitLab Pages default authentication flow. + #### DNS configuration for custom domains If support for custom domains is needed, all subdomains of the Pages root domain should point to the @@ -194,9 +201,10 @@ Watch the [video tutorial](https://youtu.be/dD8c7WNcc6s) for this configuration. ### Pages domain without wildcard DNS DETAILS: -**Status:** Experiment +**Status:** Beta -> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/17584) in GitLab 16.7. This feature is an [Experiment](../../policy/experiment-beta-support.md). +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/17584) in GitLab 16.7 as an [Experiment](../../policy/experiment-beta-support.md). +> - Available as [Beta](../../policy/experiment-beta-support.md) in GitLab 16.11. FLAG: On self-managed GitLab, by default this feature is available. @@ -283,9 +291,10 @@ then run `gitlab-ctl reconfigure`. For more information, read ### Pages domain with TLS support, without wildcard DNS DETAILS: -**Status:** Experiment +**Status:** Beta -> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/17584) in GitLab 16.7. This feature is an [Experiment](../../policy/experiment-beta-support.md). +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/17584) in GitLab 16.7 as an [Experiment](../../policy/experiment-beta-support.md). +> - Available as [Beta](../../policy/experiment-beta-support.md) in GitLab 16.11. FLAG: On self-managed GitLab, by default this feature is available. @@ -297,8 +306,8 @@ Prerequisites: - Your instance must use the Linux package installation method. - You have configured DNS setup [without a wildcard](#for-namespace-in-url-path-without-wildcard-dns). -- You have a single TLS certificate that covers your domain (like `example.com`) - and the `projects.*` version of your domain, like `projects.example.com`. +- You have a single TLS certificate that covers your domain (like `example.io`) + and the `projects.*` version of your domain, like `projects.example.io`. In this configuration, NGINX proxies all requests to the daemon. The GitLab Pages daemon doesn't listen to the outside world: -- GitLab From d1a3b7866642ebfc2ea06da627c80b7ef6ccb598 Mon Sep 17 00:00:00 2001 From: ngala Date: Thu, 4 Apr 2024 16:09:29 -0400 Subject: [PATCH 2/3] Update deployed pages url with Beta suffix --- app/views/projects/pages/_access.html.haml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/app/views/projects/pages/_access.html.haml b/app/views/projects/pages/_access.html.haml index 53a4fb4389c76a..e72194eb1bcc4a 100644 --- a/app/views/projects/pages/_access.html.haml +++ b/app/views/projects/pages/_access.html.haml @@ -2,7 +2,7 @@ - pages_url = build_pages_url(@project, with_unique_domain: true) - pages_url_text = pages_url - if Gitlab.config.pages.namespace_in_path - - pages_url_text = "#{pages_url} (Experimental)" + - pages_url_text = "#{pages_url} (Beta)" = render Pajamas::CardComponent.new(card_options: { class: 'gl-mb-5', data: { testid: 'access-page-container' } }, footer_options: { class: 'gl-alert-warning' }) do |c| - c.with_header do -- GitLab From 6d53bb42a490384053a19c26465d150f53867066 Mon Sep 17 00:00:00 2001 From: ngala Date: Thu, 11 Apr 2024 13:18:23 -0400 Subject: [PATCH 3/3] Apply documentation suggestions --- doc/administration/pages/index.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/doc/administration/pages/index.md b/doc/administration/pages/index.md index 5feae0f56f5e53..adab54b1b94a3a 100644 --- a/doc/administration/pages/index.md +++ b/doc/administration/pages/index.md @@ -102,8 +102,8 @@ IPv6 address. If you don't have IPv6, you can omit the `AAAA` record. DETAILS: **Status:** Beta -> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/17584) in GitLab 16.7 as an [Experiment](../../policy/experiment-beta-support.md). -> - Available as [Beta](../../policy/experiment-beta-support.md) in GitLab 16.11. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/17584) as an [Experiment](../../policy/experiment-beta-support.md) in GitLab 16.7. +> - [Moved](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/148621) to [Beta](../../policy/experiment-beta-support.md) in GitLab 16.11. FLAG: On self-managed GitLab, by default this feature is available. @@ -113,7 +113,7 @@ This feature is not ready for production use. Prerequisites: - Your instance must use the Linux package installation method. -- Your Linux package installation should use default `auth_redirect_uri` for GitLab Pages. +- Your installation must use the default `auth_redirect_uri`. If you need support for namespace in the URL path to remove the requirement for wildcard DNS: @@ -203,8 +203,8 @@ Watch the [video tutorial](https://youtu.be/dD8c7WNcc6s) for this configuration. DETAILS: **Status:** Beta -> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/17584) in GitLab 16.7 as an [Experiment](../../policy/experiment-beta-support.md). -> - Available as [Beta](../../policy/experiment-beta-support.md) in GitLab 16.11. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/17584) as an [Experiment](../../policy/experiment-beta-support.md) in GitLab 16.7. +> - [Moved](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/148621) to [Beta](../../policy/experiment-beta-support.md) in GitLab 16.11. FLAG: On self-managed GitLab, by default this feature is available. @@ -293,8 +293,8 @@ then run `gitlab-ctl reconfigure`. For more information, read DETAILS: **Status:** Beta -> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/17584) in GitLab 16.7 as an [Experiment](../../policy/experiment-beta-support.md). -> - Available as [Beta](../../policy/experiment-beta-support.md) in GitLab 16.11. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/17584) as an [Experiment](../../policy/experiment-beta-support.md) in GitLab 16.7. +> - [Moved](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/148621) to [Beta](../../policy/experiment-beta-support.md) in GitLab 16.11. FLAG: On self-managed GitLab, by default this feature is available. -- GitLab