Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

server 4.7 release docs #9033

Merged
merged 8 commits into from
Nov 7, 2024
Merged
2 changes: 1 addition & 1 deletion jekyll/_cci2/migration-intro.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ Some things consider during this phase:

Ensure that your VCS org is linked to your CircleCI account and that your plan is applied. Log in using your VCS credentials as described on the xref:first-steps#[Sign Up and Try CircleCI] page.

If using the Server product, ensure that you have been provided with your trial license and that all prerequisites are met as described xref:server/latest/installation/phase-1-prerequisites#[here].
If using the Server product, ensure that you have been provided with your trial license and that all prerequisites are met as described in the server installation guides (xref:server/latest/installation/phase-1-aws-prerequisites#[AWS Prerequisites] and xref:server/latest/installation/phase-1-gcp-prerequisites#[GCP Prerequisites]).

[#preparation-phase]
== Preparation phase
Expand Down
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
---
contentTags:
platform:
- Server v4.6
- Server v4.7
- Server Admin
---
= Additional considerations
:page-layout: classic-docs
:page-liquid:
:page-description: This page presents some items that should be considered when starting an air-gapped installation of CircleCI server v4.6.
:page-description: This page presents some items that should be considered when starting an air-gapped installation of CircleCI server v4.7.
:icons: font
:toc: macro
:toc-title:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
---
contentTags:
platform:
- Server v4.6
- Server v4.7
- Server Admin
---
= Example `values.yaml`
:page-layout: classic-docs
:page-liquid:
:page-description: This page presents an example values.yaml file to help with setting up an air-gapped installation of CircleCI server v4.6.
:page-description: This page presents an example values.yaml file to help with setting up an air-gapped installation of CircleCI server v4.7.
:icons: font
:toc: macro
:toc-title:
Expand All @@ -25,7 +25,10 @@ The chart assumes an environment with the following resources:
- A MinIO instance running at minio.internal.example.com, with its API listening on port 9000, and no TLS
- A TLS certificate issued for both domains `server.internal.example.com` and `*.server.internal.example.com``.

For more information about specific values, see the standard installation documentation, starting with xref:../installation/phase-2-core-services#[Phase 2 - Core services].
For more information about specific values, see the standard installation documentation, starting with the following:

* xref:../installation/phase-2-aws-core-services#[Phase 2 AWS - Core services]
* xref:../installation/phase-2-gcp-core-services#[Phase 2 GCP - Core services]

[#values]
== `Values.yaml`
Expand Down
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
---
contentTags:
platform:
- Server v4.6
- Server v4.7
- Server Admin
---
= Phase 1 - Prerequisites
:page-layout: classic-docs
:page-liquid:
:experimental:
:page-description: A guide to installing CircleCI server v4.6 in an air-gapped environment. Requirements, images and Helm charts.
:page-description: A guide to installing CircleCI server v4.7 in an air-gapped environment. Requirements, images and Helm charts.
:icons: font
:toc: macro
:toc-title:
Expand Down Expand Up @@ -61,66 +61,65 @@ Download all images required for the release of CircleCI server to your local ma

[,bash]
----
SERVER_4_6_IMAGE_LIST=`cat <<EOF
cciserver.azurecr.io/api-gateway:0.1.45202-ff4a716
cciserver.azurecr.io/api-service:0.1.18463-536327b3
cciserver.azurecr.io/approval-job-provider-migrator:1.0.21509-e6028e1
cciserver.azurecr.io/audit-log-service:0.1.1381-174cc53
cciserver.azurecr.io/authentication-svc:0.1.20159-a9f4a7c
SERVER_4_7_IMAGE_LIST=`cat <<EOF
cciserver.azurecr.io/api-gateway:0.1.49191-1d80931
cciserver.azurecr.io/api-service:0.1.19809-2c27b769
cciserver.azurecr.io/approval-job-provider-migrator:1.0.22210-1e8ba07
cciserver.azurecr.io/audit-log-service:0.1.1767-a014907
cciserver.azurecr.io/authentication-svc:0.1.31069-c3ff89c
cciserver.azurecr.io/authentication-svc-migrator:0.1.17533-7681416
cciserver.azurecr.io/branch-service:0.1.5146-5123808
cciserver.azurecr.io/branch-service-migrator:0.1.5145-5123808
cciserver.azurecr.io/builds-service:1.0.7100-691c500
cciserver.azurecr.io/builds-service-migrator:1.0.7100-691c500
cciserver.azurecr.io/ciam:0.1.27156-878504f
cciserver.azurecr.io/ciam-gateway:0.1.5476-1da932d
cciserver.azurecr.io/contexts-service:0.1.22465-a537b23
cciserver.azurecr.io/contexts-service-migrator:0.1.22464-a537b23
cciserver.azurecr.io/cron-service:0.1.4527-a0d7eb2
cciserver.azurecr.io/cron-service-migrator:0.1.4528-a0d7eb2
cciserver.azurecr.io/distributor:0.1.134861-d4723196
cciserver.azurecr.io/distributor-migrator:0.1.134859-d4723196
cciserver.azurecr.io/docker-provisioner:0.1.23245-b97d181
cciserver.azurecr.io/domain-service:0.1.17384-dc84eb6
cciserver.azurecr.io/domain-service-migrator:0.1.17385-dc84eb6
cciserver.azurecr.io/execution-gateway:0.1.21179-0f322b4
cciserver.azurecr.io/feature-flags:0.1.7167-e643d91
cciserver.azurecr.io/frontend:0.2.36533-bc09221-snapshot
cciserver.azurecr.io/init-known-hosts:0.1.94-e65564b
cciserver.azurecr.io/insights-service:0.1.86423-bebb0700
cciserver.azurecr.io/insights-service-migrator:0.1.86424-bebb0700
cciserver.azurecr.io/machine-provisioner:0.1.71874-d155311
cciserver.azurecr.io/machine-provisioner-migrator:0.1.71870-d155311
cciserver.azurecr.io/builds-service:1.0.7343-84779b5
cciserver.azurecr.io/builds-service-migrator:1.0.7343-84779b5
cciserver.azurecr.io/ciam:0.1.32056-480583e
cciserver.azurecr.io/ciam-gateway:0.1.7603-883d322
cciserver.azurecr.io/contexts-service:0.1.23652-7e97303
cciserver.azurecr.io/contexts-service-migrator:0.1.23651-7e97303
cciserver.azurecr.io/cron-service:0.1.5169-cbc93dd
cciserver.azurecr.io/cron-service-migrator:0.1.5170-cbc93dd
cciserver.azurecr.io/distributor:0.1.137585-444fb120
cciserver.azurecr.io/distributor-migrator:0.1.137584-444fb120
cciserver.azurecr.io/docker-provisioner:0.1.27473-7465c1c
cciserver.azurecr.io/domain-service:0.1.18086-464027e
cciserver.azurecr.io/domain-service-migrator:0.1.18085-464027e
cciserver.azurecr.io/execution-gateway:0.1.22605-9cd2443
cciserver.azurecr.io/feature-flags:0.1.7871-2143698
cciserver.azurecr.io/frontend:0.2.37400-0682aca-snapshot
cciserver.azurecr.io/init-known-hosts:1.0.15-4c88cf7
cciserver.azurecr.io/insights-service:0.1.89109-a6fd61a5
cciserver.azurecr.io/insights-service-migrator:0.1.89110-a6fd61a5
cciserver.azurecr.io/machine-provisioner:0.1.84130-76afc75
cciserver.azurecr.io/machine-provisioner-migrator:0.1.84123-76afc75
cciserver.azurecr.io/nomad:1.4.568-bfc9a6ec4-125-a748c37
cciserver.azurecr.io/orb-service:0.1.80219-427a8aa
cciserver.azurecr.io/orb-service-analytics-migrator:0.1.80218-427a8aa
cciserver.azurecr.io/orb-service-migrator:0.1.80217-427a8aa
cciserver.azurecr.io/output:0.1.26964-d6d9a56
cciserver.azurecr.io/permissions-service:0.1.27158-878504f
cciserver.azurecr.io/permissions-service-migrator:0.1.27157-878504f
cciserver.azurecr.io/orb-service:0.1.89027-f8ec8ae
cciserver.azurecr.io/orb-service-analytics-migrator:0.1.89028-f8ec8ae
cciserver.azurecr.io/orb-service-migrator:0.1.89025-f8ec8ae
cciserver.azurecr.io/output:0.1.28505-222a47e
cciserver.azurecr.io/permissions-service:0.1.32058-480583e
cciserver.azurecr.io/permissions-service-migrator:0.1.32057-480583e
cciserver.azurecr.io/policy-service:0.1.6789-4e9d8f6
cciserver.azurecr.io/runner-admin:0.1.20252-909fd7b
cciserver.azurecr.io/runner-admin-migrator:0.1.20236-909fd7b
cciserver.azurecr.io/server-license:0.1.256-f54cc54
cciserver.azurecr.io/runner-admin:0.1.22266-f606ca5
cciserver.azurecr.io/runner-admin-migrator:0.1.22253-f606ca5
cciserver.azurecr.io/server-license:1.0.14-9cb1f65
cciserver.azurecr.io/server-postgres:12.16.135-34b4cfa
cciserver.azurecr.io/server-postgres:12.16.37-7629bfd
cciserver.azurecr.io/server-postgres:12.16.76-f78dd8d
cciserver.azurecr.io/step:0.1.7270-bd6f914
cciserver.azurecr.io/step:0.1.8536-cb55342
cciserver.azurecr.io/vault-cci:0.4.196-1af3417
cciserver.azurecr.io/webhook-service:0.1.9796-7424165
cciserver.azurecr.io/webhook-service-migrator:0.1.9790-7424165
cciserver.azurecr.io/web-ui:0.1.23582-1257bf5cd
cciserver.azurecr.io/web-ui-404:0.1.22986-1057f8a88
cciserver.azurecr.io/web-ui-authentication:0.1.28453-91aba168a
cciserver.azurecr.io/web-ui-insights:0.1.23382-1e8f5bebe
cciserver.azurecr.io/web-ui-onboarding:0.1.24126-8b8953b8a
cciserver.azurecr.io/web-ui-org-settings:0.1.26851-fef0e040a
cciserver.azurecr.io/web-ui-project-settings:0.1.24141-719b10e11
cciserver.azurecr.io/web-ui-runners:0.1.23317-f9a8c3114
cciserver.azurecr.io/web-ui-server-admin:0.1.3487-87c7ad7
cciserver.azurecr.io/web-ui-user-settings:0.1.23169-4a8dd825c
cciserver.azurecr.io/workflows-conductor:1.0.21574-1fe47dd
cciserver.azurecr.io/workflows-conductor-migrator:1.0.21509-e6028e1
circleci/picard:1.0.246523-server-4.6-c5b4f03f
cciserver.azurecr.io/webhook-service:0.1.10044-e27a44a
cciserver.azurecr.io/webhook-service-migrator:0.1.10042-e27a44a
cciserver.azurecr.io/web-ui:0.1.65498-227ac7d06f
cciserver.azurecr.io/web-ui-authentication:0.1.64589-37b6c819c1
cciserver.azurecr.io/web-ui-insights:0.1.63994-b0c0ae8ea1
cciserver.azurecr.io/web-ui-onboarding:0.1.65876-d922ac933b
cciserver.azurecr.io/web-ui-org-settings:0.1.65496-227ac7d06f
cciserver.azurecr.io/web-ui-project-settings:0.1.62023-b851e0d9bd
cciserver.azurecr.io/web-ui-runners:0.1.64064-db6d5c6481
cciserver.azurecr.io/web-ui-server-admin:0.1.3937-5250c09
cciserver.azurecr.io/web-ui-user-settings:0.1.63989-b0c0ae8ea1
cciserver.azurecr.io/workflows-conductor:1.0.22210-1e8ba07
cciserver.azurecr.io/workflows-conductor-migrator:1.0.22210-1e8ba07
circleci/picard:1.0.254724-7e8e2f9b
docker.io/bitnami/mongodb:3.6.22-debian-9-r38
docker.io/bitnami/rabbitmq:3.11.16-debian-11-r0
docker.io/bitnami/redis:6.2.1-debian-10-r13
Expand All @@ -129,7 +128,7 @@ jimmidyson/configmap-reload:v0.5.0
k8s.gcr.io/kube-state-metrics/kube-state-metrics:v2.3.0
kong:3.3.1
mongo:3.6
nginx:1.27.0
nginxinc/nginx-unprivileged:1.27.0
prom/pushgateway:v1.4.2
quay.io/prometheus/alertmanager:v0.23.0
quay.io/prometheus/node-exporter:v1.3.0
Expand All @@ -142,7 +141,7 @@ EOF

[source, bash]
----
echo $SERVER_4_6_IMAGE_LIST | while read -r image; do docker pull $image; done
echo $SERVER_4_7_IMAGE_LIST | while read -r image; do docker pull $image; done
----

[#copy-all-images]
Expand Down
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
---
contentTags:
platform:
- Server v4.6
- Server v4.7
- Server Admin
---
= Phase 2 - Configure object storage
:page-layout: classic-docs
:page-liquid:
:page-description: How to configure object storage through MinIO to run CircleCI server v4.6 in an air-gapped environment.
:page-description: How to configure object storage through MinIO to run CircleCI server v4.7 in an air-gapped environment.
:icons: font
:experimental:
:toc: macro
Expand Down
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
---
contentTags:
platform:
- Server v4.6
- Server v4.7
- Server Admin
---
= Phase 3 - install CircleCI server
:page-layout: classic-docs
:page-liquid:
:page-description: How to install the CircleCI server v4.6 Helm deployment to an air-gapped environment.
:page-description: How to install the CircleCI server v4.7 Helm deployment to an air-gapped environment.
:icons: font
:toc: macro
:toc-title:
Expand All @@ -16,7 +16,7 @@ With prerequisites installed, and object storage configured, you can now copy ov

[#prepare-values-yaml]
== 1. Prepare `values.yaml`
The `values.yaml` file for installing CircleCI should be prepared according to the xref:../installation/phase-2-core-services/#create-helm-values[Create Helm values] section of the regular installation guide. Once this is complete, you will modify the fields listed in the steps below for air-gapped installation compatibility.
The `values.yaml` file for installing CircleCI should be prepared according to the Create Helm Values section of the regular installation guide (xref:../installation/phase-2-aws-core-services/#create-helm-values[AWS], xref:../installation/phase-2-gcp-core-services/#create-helm-values[GCP]). Once this is complete, you will modify the fields listed in the steps below for air-gapped installation compatibility.

=== a. Configure global values

Expand Down Expand Up @@ -47,7 +47,7 @@ The `hostname` value should be the internal hostname of your GitHub enterprise i

If this instance is not using TLS or self-signed certificates, make sure to set the `unsafeDisableWebhookSSLVerification: true` and `selfSignedCert: true` values.

Additionally, an OAuth application and a personal access token should be set in GitHub Enterprise and values provided as shown below. For more information about this process, see the documentation for creating a xref:../installation/phase-1-prerequisites/#create-a-new-github-oauth-app[GitHub OAuth application].
Additionally, an OAuth application and a personal access token should be set in GitHub Enterprise and values provided as shown below. For more information about this process, see the documentation for creating a GitHub OAuth application. For details, see the xref:../installation/phase-1-aws-prerequisites/#create-a-new-github-oauth-app[AWS] or xref:../installation/phase-1-gcp-prerequisites/#create-a-new-github-oauth-app[GCP] installation guide.

[source, yaml]
----
Expand Down Expand Up @@ -155,7 +155,7 @@ We recommend first creating a namespace (`circleci-server`) and deploying the ch

[source,bash,subs=attributes+]
----
helm install circleci-server ./circleci-server/ -n <kubernetes-namespace> --version {serverversion46} -f <path-to-values.yaml>
helm install circleci-server ./circleci-server/ -n <kubernetes-namespace> --version {serverversion47} -f <path-to-values.yaml>
----

[#post-install-circleci-server-helm-airgap]
Expand Down
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
---
contentTags:
platform:
- Server v4.6
- Server v4.7
- Server Admin
---
= Phase 4 - Configure Nomad clients
:page-layout: classic-docs
:page-liquid:
:page-description: How to configure Nomad clients to run with CircleCI server v4.6 in an air-gapped environment.
:page-description: How to configure Nomad clients to run with CircleCI server v4.7 in an air-gapped environment.
:icons: font
:toc: macro
:toc-title:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
---
contentTags:
platform:
- Server v4.6
- Server v4.7
- Server Admin
---
= Phase 5 - Test your installation
:page-layout: classic-docs
:page-liquid:
:page-description: How to test your CircleCI server v4.6 installation in an air-gapped environment.
:page-description: How to test your CircleCI server v4.7 installation in an air-gapped environment.
:icons: font
:toc: macro
:toc-title:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
---
contentTags:
platform:
- Server v4.6
- Server v4.7
- Server Admin
---
= Hardening your cluster
:page-layout: classic-docs
:page-liquid:
:page-description: This section provides supplemental information on hardening your Kubernetes cluster for CircleCI server v4.6.
:page-description: This section provides supplemental information on hardening your Kubernetes cluster for CircleCI server v4.7.
:icons: font
:toc: macro
:toc-title:
Expand Down Expand Up @@ -282,5 +282,5 @@ When hardening an installation where the machine provisioner uses public IP addr

ifndef::pdf[]
## Next steps
* xref:../operator/operator-overview#[Server v4.6 Operator Overview]
* xref:../operator/operator-overview#[Server v4.7 Operator Overview]
endif::[]
Loading