Skip to content

Commit

Permalink
Merge pull request #2196 from OctopusDeploy/tk/kubernetes-overview-page
Browse files Browse the repository at this point in the history
Kubernetes Docs overview page updates
  • Loading branch information
tonykelly-octopus authored Mar 20, 2024
2 parents 0d8d9dc + 674ae7b commit e7cd58e
Show file tree
Hide file tree
Showing 29 changed files with 93 additions and 56 deletions.
4 changes: 2 additions & 2 deletions public/docs/css/main.css
Original file line number Diff line number Diff line change
Expand Up @@ -561,8 +561,8 @@ nav.skip-links a:focus {

.docs-home {
text-align: center;
margin-block-start: 10vh;
margin-block-end: 10vh;
margin-block-start: 5vh;
margin-block-end: 5vh;
}

/* card */
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added public/docs/i/1000/helm-logo.webp
Binary file not shown.
Binary file added public/docs/i/1000/kustomize-octopus-logo.webp
Binary file not shown.
Binary file added public/docs/i/1000/octopus-deploy-logo.webp
Binary file not shown.
Binary file added public/docs/i/1000/yaml-logo.webp
Binary file not shown.
Binary file added public/docs/i/2000/helm-logo.webp
Binary file not shown.
Binary file added public/docs/i/2000/kustomize-octopus-logo.webp
Binary file not shown.
Binary file added public/docs/i/2000/octopus-deploy-logo.webp
Binary file not shown.
Binary file added public/docs/i/2000/yaml-logo.webp
Binary file not shown.
Binary file added public/docs/i/600/helm-logo.webp
Binary file not shown.
Binary file added public/docs/i/600/kustomize-octopus-logo.webp
Binary file not shown.
Binary file added public/docs/i/600/octopus-deploy-logo.webp
Binary file not shown.
Binary file added public/docs/i/600/yaml-logo.webp
Binary file not shown.
Binary file added public/docs/i/x/helm-logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added public/docs/i/x/kustomize-octopus-logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added public/docs/i/x/octopus-deploy-logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added public/docs/i/x/yaml-logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added public/docs/img/helm-logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions public/docs/img/helm-logo.png.json
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{"width":640,"height":228}
Binary file added public/docs/img/kustomize-octopus-logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions public/docs/img/kustomize-octopus-logo.png.json
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{"width":640,"height":228}
Binary file added public/docs/img/octopus-deploy-logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions public/docs/img/octopus-deploy-logo.png.json
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{"width":640,"height":228}
Binary file added public/docs/img/yaml-logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions public/docs/img/yaml-logo.png.json
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{"width":640,"height":228}
54 changes: 0 additions & 54 deletions src/pages/docs/deployments/kubernetes/index.md

This file was deleted.

87 changes: 87 additions & 0 deletions src/pages/docs/deployments/kubernetes/index.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,87 @@
---
layout: src/layouts/Default.astro
pubDate: 2023-01-01
modDate: 2024-03-20
title: Kubernetes
description: Octopus Deploy provides support for deploying Kubernetes resources.
navOrder: 80
hideInThisSectionHeader: true
---
import RecentlyUpdated from '@components/RecentlyUpdated.astro';
import Card from 'src/components/Card.astro';

Octopus Deploy makes it easy to manage your Kubernetes resources, whether you're starting simple or want complete control over a complex setup. This section has everything you need to know about using Octopus for Kubernetes CD.

- Tutorials and guides for different deployment scenarios, from a simple proof of concept to enterprise-scale GitOps
- Kubernetes best practices
- Octopus documentation for built-in steps and targets

:::figure
![Kubernetes pipeline](/docs/deployments/kubernetes/pipeline-visual-k8s.png)
:::

## Why use Octopus as your Kubernetes CD platform
- Model environments and tenants for hundreds of applications with ease.
- Work with any Kubernetes distribution in the cloud or on-premises. Source YAML or Helm charts from Git or repositories.
- Use the centralized dashboard and detailed resource status to learn the state of all your deployments and clusters in an instant.
- Use configuration templates across environments, tenants, or even applications.
- Automate routine maintenance and respond faster to emergencies:
- Octopus [runbooks](https://octopus.com/docs/runbooks/) and [projects](https://octopus.com/docs/projects) share the same variables and accounts to interact with your clusters
- Use pre-approved [kubectl](https://octopus.com/docs/deployments/kubernetes/kubectl) scripts

## Getting started
With Octopus, you can choose between managing your application configuration with Helm charts or YAML.

::::div{.docs-home .simple-grid}

<Card
description="Learn more about how you can use Octopus variables for Helm values in our Helm documentation."
imgAlt="Helm logo"
imgSrc="/docs/img/helm-logo.png"
link="/docs/deployments/kubernetes/helm-update"
title="Helm deployment guide"
/>

<Card
description="Start with our YAML deployment guide if you intend to use plain YAML."
imgAlt="Yaml logo"
imgSrc="/docs/img/yaml-logo.png"
link="/docs/getting-started/first-kubernetes-deployment"
title="YAML deployment guide"
/>

<Card
description="Consider using Kustomize with Octopus for more templating capabilities."
imgAlt="Kustomize and Octopus logo"
imgSrc="/docs/img/kustomize-octopus-logo.png"
link="/docs/deployments/kubernetes/kustomize"
title="Kustomize with Octopus"
/>

<Card
description="You can also create a configuration with our UI, and Octopus will generate YAML behind the scenes for you."
imgAlt="Octopus logo"
imgSrc="/docs/img/octopus-deploy-logo.png"
link="/docs/deployments/kubernetes/deploy-container"
title="Use the Octopus UI"
/>

::::

## First production deployment
When you’re ready to apply Octopus to a real scenario, we recommend that you:
- Familiarize yourself with 3 fundamental Octopus concepts: [projects](https://octopus.com/docs/projects), [environments](https://octopus.com/docs/infrastructure/environments), and [targets](https://octopus.com/docs/infrastructure/deployment-targets). When you have time, you can learn about other Octopus concepts in our [glossary](https://octopus.com/docs/getting-started/glossary).
- Learn how to implement GitOps best practices with Octopus and use our observability features.

## Deployments at scale
Learn more about deploying to multiple apps with Octopus, with these guides:
- Release triggers [link] and [channels](https://octopus.com/docs/releases/channels) to automate deployments
- [Step templates](https://octopus.com/docs/projects/custom-step-templates) to create new pipelines with ease
- [Configuration as Code](https://octopus.com/docs/projects/version-control) to manage deployment pipeline versions
- [Users, roles, and teams](https://octopus.com/docs/getting-started/best-practices/users-roles-and-teams)
- Maintenance tasks with [runbooks](https://octopus.com/docs/runbooks/) and [scripts](https://octopus.com/docs/deployments/kubernetes/kubectl)

## Learn more
- Learn more about [Kubernetes deployments with Octopus](https://octopus.com/use-case/kubernetes)
- How to choose between [Kubernetes deployment targets](https://octopus.com/docs/infrastructure/deployment-targets/kubernetes-target)
- [Learn more about Kubernetes](https://octopus.com/blog/search?context=blog&q=kubernetes) on our blog

0 comments on commit e7cd58e

Please sign in to comment.