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 86cdc3cc0e..c160463e10 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. diff --git a/source/kubernetes/index.html.md b/source/kubernetes/index.html.md index dc4312b815..328b690489 100644 --- a/source/kubernetes/index.html.md +++ b/source/kubernetes/index.html.md @@ -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 +## 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. -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.