From 348a56afa89c7c416059c107b751b4c2d9ceb694 Mon Sep 17 00:00:00 2001 From: jasonBirchall Date: Tue, 28 Jan 2025 15:46:45 +0000 Subject: [PATCH 1/6] =?UTF-8?q?=E2=99=BB=EF=B8=8F=20Make=20title=20more=20?= =?UTF-8?q?concise?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../tutorials/app-update-deploy-monitor-logs/index.html.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/source/kubernetes/get-started/tutorials/app-update-deploy-monitor-logs/index.html.md b/source/kubernetes/get-started/tutorials/app-update-deploy-monitor-logs/index.html.md index 86cdc3cc0e5..c160463e102 100644 --- a/source/kubernetes/get-started/tutorials/app-update-deploy-monitor-logs/index.html.md +++ b/source/kubernetes/get-started/tutorials/app-update-deploy-monitor-logs/index.html.md @@ -1,10 +1,10 @@ --- -title: Deploy a new version of the example test app, check the deployment, monitor the app on Grafana and view application logs +title: Update, Deploy and Monitor an Application weight: 20 layout: multipage_layout --- -# Deploy a new version of the example test app, check the deployment, monitor the app on Grafana and view application logs +# Update, Deploy and Monitor an Application This tutorial will teach you how to deploy changes to an app and how to view application metrics and logs. From 8c682b371fa7e94d3cbc30b4f5480c63046f89fd Mon Sep 17 00:00:00 2001 From: jasonBirchall Date: Tue, 28 Jan 2025 15:47:30 +0000 Subject: [PATCH 2/6] =?UTF-8?q?=E2=99=BB=EF=B8=8F=20Refactor=20index=20pag?= =?UTF-8?q?e=20to=20include=20user-guide=20and=20runbooks?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- source/kubernetes/index.html.md | 71 ++++++++++++++++++++++++--------- 1 file changed, 53 insertions(+), 18 deletions(-) diff --git a/source/kubernetes/index.html.md b/source/kubernetes/index.html.md index dc4312b8153..d95094d7ff3 100644 --- a/source/kubernetes/index.html.md +++ b/source/kubernetes/index.html.md @@ -1,31 +1,66 @@ --- -title: GOV.UK Kubernetes cluster documentation for developers +title: GOV.UK Internal Developer Platform weight: 1 layout: multipage_layout --- -# GOV.UK Kubernetes cluster documentation for developers +# GOV.UK Internal Developer Platform -Use this documentation to find out how to: +The GOV.UK Internal Developer Platform is a centralised platform where teams can build, deploy, and manage applications in a reliable and secure environment. -- start using the GOV.UK Kubernetes clusters -- manage your GOV.UK app on Kubernetes +This documentation is designed for both platform users and internal team members, providing guides, tools, and best practices to onboard, manage, and troubleshoot your applications effectively. -## Introduction +## Who is this for? -The GOV.UK website and content management system (known internally as the publishing platform) are hosted on [Kubernetes](https://kubernetes.io/) clusters on Amazon Web Services (AWS), using [Elastic Kubernetes Service](https://aws.amazon.com/eks/) (EKS). +This documentation is for: -Kubernetes is a widely-used, open-source [container orchestration system](https://cloud.google.com/discover/what-is-container-orchestration) for managing containerised workloads such as GOV.UK's. +- Developers, engineers, and stakeholders deploying and managing applications on the platform. -Kubernetes is designed for automation and emphasises [declarative configuration](https://github.com/kubernetes/design-proposals-archive/blob/main/architecture/declarative-application-management.md#declarative-configuration) and [immutable infrastructure](https://thenewstack.io/a-brief-look-at-immutable-infrastructure-and-why-it-is-such-a-quest/). It provides mechanisms for: +- Platform engineers and administrators responsible for maintaining and extending the platform. -- efficiently and automatically fitting workloads into available compute resources -- resilient, "self-healing" deployments -- service discovery and load balancing -- automated rollouts and rollbacks -- quotas and isolation of compute resources between workloads -- authentication, authorisation and audit logging -- secrets and configuration management -- managing persistent storage +## User Guide + +This section is specifically for application developers using the platform. The platform is designed to reduce cognitive load for developers by abstracting away infrastructure complexity and providing tools, guides, and automated workflows. + +If there’s something missing, please either let us know and we’ll add a new article, or if you’re comfortable writing one yourself, PRs will be gratefully received. + +### Getting Started + +- [Gain access to a platform EKS Cluster](../../kubernetes/get-started/access-eks-cluster/index.html) +- [Set up the recommended tools](../../kubernetes/get-started/set-up-tools/index.html) +- [Understand how the platform works](../../kubernetes/how-platform-works/index.html) + +### Tutorials + +- [Create a new application](../../kubernetes/create-app/index.html) +- [Update an application's environment in our Helm charts](../../kubernetes/get-started/tutorials/app-config-deploy-helm-chart/index.html) +- [Update, deploy, and monitor an application](../../kubernetes/get-started/tutorials/app-update-deploy-monitor-logs/index.html) +- [Set or change an environment variable in your application](../../kubernetes/manage-app/set-env-var/index.html) +- [Add secrets to your application](../../kubernetes/manage-app/manage-secrets/index.html) +- [Horizontally and vertically scale your application](../../kubernetes/manage-app/scale-app/index.html) +- [Rolling Back Applications](../../kubernetes/manage-app/roll-back-app/index.html) +- [Fix your application when something's gone wrong](../../kubernetes/fix-app/index.html) +- [View your application and inspect Kubernetes via the command-line](../../kubernetes/manage-app/get-app-info/index.html) +- [Troubleshoot your failed deployment](../../kubernetes/manage-app/manage-state/index.html) + +### Concepts + +- [How we release a new version of your app](../../kubernetes/manage-app/release-new-version/index.html) +- [How is your application deployed](../../kubernetes/manage-app/access-ci-cd/index.html) + +## Runbooks + +This section is specifically for platform engineers and administrators and should act as a place for knowledge capture and ways of working practices. + +### Common tasks + +- [Create New Environments](../../kubernetes/manage-app/create-new-env/index.html) + +## Cheatsheet + +Quickly reference common commands and workflows in the [Cheatsheet](../../kubernetes/cheatsheet.html). + +## Contact the Platform Engineering Team + +Need help? Visit [Contact the Platform Engineering Team](../../kubernetes/contact-platform-engineering-team.html) for support options. -See the official [Kubernetes overview documentation](https://kubernetes.io/docs/concepts/overview/what-is-kubernetes/) for more information about Kubernetes. From 5dacb16d4ed646b5b44a11d981cc0289958fb14b Mon Sep 17 00:00:00 2001 From: jasonBirchall Date: Wed, 29 Jan 2025 09:31:02 +0000 Subject: [PATCH 3/6] =?UTF-8?q?=E2=99=BB=EF=B8=8F=20Align=20documentation?= =?UTF-8?q?=20with=20GOV.UK=20style=20guide=20for=20clarity=20and=20consis?= =?UTF-8?q?tency?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- source/kubernetes/index.html.md | 36 ++++++++++++++++----------------- 1 file changed, 17 insertions(+), 19 deletions(-) diff --git a/source/kubernetes/index.html.md b/source/kubernetes/index.html.md index d95094d7ff3..a144209867e 100644 --- a/source/kubernetes/index.html.md +++ b/source/kubernetes/index.html.md @@ -8,59 +8,57 @@ layout: multipage_layout The GOV.UK Internal Developer Platform is a centralised platform where teams can build, deploy, and manage applications in a reliable and secure environment. -This documentation is designed for both platform users and internal team members, providing guides, tools, and best practices to onboard, manage, and troubleshoot your applications effectively. +This documentation is for both platform users and internal team members. It provides guides, tools, and best practices to help onboard, manage, and troubleshoot applications efficiently. -## Who is this for? +## Who this guide is for This documentation is for: -- Developers, engineers, and stakeholders deploying and managing applications on the platform. - -- Platform engineers and administrators responsible for maintaining and extending the platform. +- **Developers and engineers**: Deploying and managing applications on the platform. +- **Platform engineers and administrators**: Maintaining and extending the platform. ## User Guide -This section is specifically for application developers using the platform. The platform is designed to reduce cognitive load for developers by abstracting away infrastructure complexity and providing tools, guides, and automated workflows. +This section is for application developers using the platform. The platform reduces cognitive load by abstracting infrastructure complexity and providing tools, guides, and automated workflows. -If there’s something missing, please either let us know and we’ll add a new article, or if you’re comfortable writing one yourself, PRs will be gratefully received. +If something is missing, let us know, and we’ll add an article. If you're comfortable contributing, pull requests (PRs) are welcome. ### Getting Started -- [Gain access to a platform EKS Cluster](../../kubernetes/get-started/access-eks-cluster/index.html) +- [Gain access to a platform EKS cluster](../../kubernetes/get-started/access-eks-cluster/index.html) - [Set up the recommended tools](../../kubernetes/get-started/set-up-tools/index.html) - [Understand how the platform works](../../kubernetes/how-platform-works/index.html) ### Tutorials - [Create a new application](../../kubernetes/create-app/index.html) -- [Update an application's environment in our Helm charts](../../kubernetes/get-started/tutorials/app-config-deploy-helm-chart/index.html) +- [Update an application's environment in Helm charts](../../kubernetes/get-started/tutorials/app-config-deploy-helm-chart/index.html) - [Update, deploy, and monitor an application](../../kubernetes/get-started/tutorials/app-update-deploy-monitor-logs/index.html) -- [Set or change an environment variable in your application](../../kubernetes/manage-app/set-env-var/index.html) +- [Set or change an environment variable](../../kubernetes/manage-app/set-env-var/index.html) - [Add secrets to your application](../../kubernetes/manage-app/manage-secrets/index.html) - [Horizontally and vertically scale your application](../../kubernetes/manage-app/scale-app/index.html) -- [Rolling Back Applications](../../kubernetes/manage-app/roll-back-app/index.html) -- [Fix your application when something's gone wrong](../../kubernetes/fix-app/index.html) -- [View your application and inspect Kubernetes via the command-line](../../kubernetes/manage-app/get-app-info/index.html) -- [Troubleshoot your failed deployment](../../kubernetes/manage-app/manage-state/index.html) +- [Roll back applications](../../kubernetes/manage-app/roll-back-app/index.html) +- [Fix your application when something goes wrong](../../kubernetes/fix-app/index.html) +- [View your application and inspect Kubernetes using the command line](../../kubernetes/manage-app/get-app-info/index.html) +- [Troubleshoot failed deployments](../../kubernetes/manage-app/manage-state/index.html) ### Concepts - [How we release a new version of your app](../../kubernetes/manage-app/release-new-version/index.html) -- [How is your application deployed](../../kubernetes/manage-app/access-ci-cd/index.html) +- [How applications are deployed](../../kubernetes/manage-app/access-ci-cd/index.html) ## Runbooks -This section is specifically for platform engineers and administrators and should act as a place for knowledge capture and ways of working practices. +This section is for **platform engineers and administrators**. It serves as a central place for capturing knowledge and documenting ways of working. ### Common tasks -- [Create New Environments](../../kubernetes/manage-app/create-new-env/index.html) +- [Create new environments](../../kubernetes/manage-app/create-new-env/index.html) ## Cheatsheet -Quickly reference common commands and workflows in the [Cheatsheet](../../kubernetes/cheatsheet.html). +Quickly reference common commands and workflows in the [cheatsheet](../../kubernetes/cheatsheet.html). ## Contact the Platform Engineering Team Need help? Visit [Contact the Platform Engineering Team](../../kubernetes/contact-platform-engineering-team.html) for support options. - From a72377a1fcd8d482523d0639ba7bf928ef73061b Mon Sep 17 00:00:00 2001 From: jasonBirchall Date: Fri, 7 Feb 2025 13:30:49 +0000 Subject: [PATCH 4/6] =?UTF-8?q?=E2=99=BB=EF=B8=8F=20Remove=20sub-section?= =?UTF-8?q?=20and=20add=20feeback=20section?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- source/kubernetes/index.html.md | 21 ++++++++------------- 1 file changed, 8 insertions(+), 13 deletions(-) diff --git a/source/kubernetes/index.html.md b/source/kubernetes/index.html.md index a144209867e..49a07eac71c 100644 --- a/source/kubernetes/index.html.md +++ b/source/kubernetes/index.html.md @@ -10,22 +10,17 @@ The GOV.UK Internal Developer Platform is a centralised platform where teams can This documentation is for both platform users and internal team members. It provides guides, tools, and best practices to help onboard, manage, and troubleshoot applications efficiently. -## Who this guide is for - -This documentation is for: - -- **Developers and engineers**: Deploying and managing applications on the platform. -- **Platform engineers and administrators**: Maintaining and extending the platform. - ## User Guide -This section is for application developers using the platform. The platform reduces cognitive load by abstracting infrastructure complexity and providing tools, guides, and automated workflows. +This section is for application developers using the platform. The platform intends to reduce cognitive load by abstracting infrastructure complexity and providing tools, guides, and automated workflows. If something is missing, let us know, and we’ll add an article. If you're comfortable contributing, pull requests (PRs) are welcome. +It would also be helpful to hear how you've found this documentation. Did it help or hinder? Let us know using the contact us links below. + ### Getting Started -- [Gain access to a platform EKS cluster](../../kubernetes/get-started/access-eks-cluster/index.html) +- [Gain access to a platform cluster](../../kubernetes/get-started/access-eks-cluster/index.html) - [Set up the recommended tools](../../kubernetes/get-started/set-up-tools/index.html) - [Understand how the platform works](../../kubernetes/how-platform-works/index.html) @@ -47,6 +42,10 @@ If something is missing, let us know, and we’ll add an article. If you're comf - [How we release a new version of your app](../../kubernetes/manage-app/release-new-version/index.html) - [How applications are deployed](../../kubernetes/manage-app/access-ci-cd/index.html) +### Cheatsheet + +Quickly reference common commands and workflows in the [cheatsheet](../../kubernetes/cheatsheet.html). + ## Runbooks This section is for **platform engineers and administrators**. It serves as a central place for capturing knowledge and documenting ways of working. @@ -55,10 +54,6 @@ This section is for **platform engineers and administrators**. It serves as a ce - [Create new environments](../../kubernetes/manage-app/create-new-env/index.html) -## Cheatsheet - -Quickly reference common commands and workflows in the [cheatsheet](../../kubernetes/cheatsheet.html). - ## Contact the Platform Engineering Team Need help? Visit [Contact the Platform Engineering Team](../../kubernetes/contact-platform-engineering-team.html) for support options. From 2d0604cba1601ba62ccecc86891c2f52abc06511 Mon Sep 17 00:00:00 2001 From: jasonBirchall Date: Tue, 11 Feb 2025 16:58:59 +0000 Subject: [PATCH 5/6] =?UTF-8?q?=F0=9F=94=A5=20Remove=20the=20term=20intern?= =?UTF-8?q?al=20'developer'=20platform?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit This excludes a large number of users who might be put off by that term. --- source/kubernetes/index.html.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/source/kubernetes/index.html.md b/source/kubernetes/index.html.md index 49a07eac71c..fe8b7e2e6f6 100644 --- a/source/kubernetes/index.html.md +++ b/source/kubernetes/index.html.md @@ -4,9 +4,9 @@ weight: 1 layout: multipage_layout --- -# GOV.UK Internal Developer Platform +# GOV.UK Internal Platform -The GOV.UK Internal Developer Platform is a centralised platform where teams can build, deploy, and manage applications in a reliable and secure environment. +The GOV.UK Internal Platform is a centralised platform where teams can build, deploy, and manage applications in a reliable and secure environment. This documentation is for both platform users and internal team members. It provides guides, tools, and best practices to help onboard, manage, and troubleshoot applications efficiently. From 8be01fe823b6dbe449f4cc753e470c9c22ee2344 Mon Sep 17 00:00:00 2001 From: jasonBirchall Date: Wed, 12 Feb 2025 09:45:01 +0000 Subject: [PATCH 6/6] =?UTF-8?q?=F0=9F=94=A5=20Use=20relative=20paths=20for?= =?UTF-8?q?=20links?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- source/kubernetes/index.html.md | 36 ++++++++++++++++----------------- 1 file changed, 18 insertions(+), 18 deletions(-) diff --git a/source/kubernetes/index.html.md b/source/kubernetes/index.html.md index fe8b7e2e6f6..328b6904898 100644 --- a/source/kubernetes/index.html.md +++ b/source/kubernetes/index.html.md @@ -20,31 +20,31 @@ It would also be helpful to hear how you've found this documentation. Did it hel ### Getting Started -- [Gain access to a platform cluster](../../kubernetes/get-started/access-eks-cluster/index.html) -- [Set up the recommended tools](../../kubernetes/get-started/set-up-tools/index.html) -- [Understand how the platform works](../../kubernetes/how-platform-works/index.html) +- [Gain access to a platform cluster](/kubernetes/get-started/access-eks-cluster/index.html) +- [Set up the recommended tools](/kubernetes/get-started/set-up-tools/index.html) +- [Understand how the platform works](/kubernetes/how-platform-works/index.html) ### Tutorials -- [Create a new application](../../kubernetes/create-app/index.html) -- [Update an application's environment in Helm charts](../../kubernetes/get-started/tutorials/app-config-deploy-helm-chart/index.html) -- [Update, deploy, and monitor an application](../../kubernetes/get-started/tutorials/app-update-deploy-monitor-logs/index.html) -- [Set or change an environment variable](../../kubernetes/manage-app/set-env-var/index.html) -- [Add secrets to your application](../../kubernetes/manage-app/manage-secrets/index.html) -- [Horizontally and vertically scale your application](../../kubernetes/manage-app/scale-app/index.html) -- [Roll back applications](../../kubernetes/manage-app/roll-back-app/index.html) -- [Fix your application when something goes wrong](../../kubernetes/fix-app/index.html) -- [View your application and inspect Kubernetes using the command line](../../kubernetes/manage-app/get-app-info/index.html) -- [Troubleshoot failed deployments](../../kubernetes/manage-app/manage-state/index.html) +- [Create a new application](/kubernetes/create-app/index.html) +- [Update an application's environment in Helm charts](/kubernetes/get-started/tutorials/app-config-deploy-helm-chart/index.html) +- [Update, deploy, and monitor an application](/kubernetes/get-started/tutorials/app-update-deploy-monitor-logs/index.html) +- [Set or change an environment variable](/kubernetes/manage-app/set-env-var/index.html) +- [Add secrets to your application](/kubernetes/manage-app/manage-secrets/index.html) +- [Horizontally and vertically scale your application](/kubernetes/manage-app/scale-app/index.html) +- [Roll back applications](/kubernetes/manage-app/roll-back-app/index.html) +- [Fix your application when something goes wrong](/kubernetes/fix-app/index.html) +- [View your application and inspect Kubernetes using the command line](/kubernetes/manage-app/get-app-info/index.html) +- [Troubleshoot failed deployments](/kubernetes/manage-app/manage-state/index.html) ### Concepts -- [How we release a new version of your app](../../kubernetes/manage-app/release-new-version/index.html) -- [How applications are deployed](../../kubernetes/manage-app/access-ci-cd/index.html) +- [How we release a new version of your app](/kubernetes/manage-app/release-new-version/index.html) +- [How applications are deployed](/kubernetes/manage-app/access-ci-cd/index.html) ### Cheatsheet -Quickly reference common commands and workflows in the [cheatsheet](../../kubernetes/cheatsheet.html). +Quickly reference common commands and workflows in the [cheatsheet](/kubernetes/cheatsheet.html). ## Runbooks @@ -52,8 +52,8 @@ This section is for **platform engineers and administrators**. It serves as a ce ### Common tasks -- [Create new environments](../../kubernetes/manage-app/create-new-env/index.html) +- [Create new environments](/kubernetes/manage-app/create-new-env/index.html) ## Contact the Platform Engineering Team -Need help? Visit [Contact the Platform Engineering Team](../../kubernetes/contact-platform-engineering-team.html) for support options. +Need help? Visit [Contact the Platform Engineering Team](/kubernetes/contact-platform-engineering-team.html) for support options.