-
Notifications
You must be signed in to change notification settings - Fork 35
♻️ Refactor platform index page to include user-guide and runbook sections #4967
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
base: main
Are you sure you want to change the base?
Changes from all commits
348a56a
8c682b3
5dacb16
a72377a
2d0604c
8be01fe
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Not for now, but if this is more "platform" than Kubernetes, we probably want to remap the path to reflect that. |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,31 +1,59 @@ | ||
| --- | ||
| 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 Platform | ||
|
|
||
| Use this documentation to find out how to: | ||
| The GOV.UK Internal 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 for both platform users and internal team members. It provides guides, tools, and best practices to help onboard, manage, and troubleshoot applications efficiently. | ||
|
|
||
| ## Introduction | ||
jasonBirchall marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| ## User Guide | ||
|
|
||
| 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 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. | ||
|
|
||
| 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. | ||
| If something is missing, let us know, and we’ll add an article. If you're comfortable contributing, pull requests (PRs) are welcome. | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Add an anchor link to the #contact-the-platform-engineering-team section? Or direct to the page? (And possibly in the next paragraph too) |
||
|
|
||
| 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: | ||
| 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. | ||
|
|
||
| - 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 | ||
| ### Getting Started | ||
|
|
||
| See the official [Kubernetes overview documentation](https://kubernetes.io/docs/concepts/overview/what-is-kubernetes/) for more information about Kubernetes. | ||
| - [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) | ||
|
|
||
| ### 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) | ||
|
|
||
| ### 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. | ||
|
|
||
| ### Common tasks | ||
|
|
||
| - [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. | ||
Uh oh!
There was an error while loading. Please reload this page.