Skip to content

Commit

Permalink
Merge pull request #2554 from OctopusDeploy/remove-old-callouts
Browse files Browse the repository at this point in the history
Consolidate step update callouts
  • Loading branch information
steve-fenton-octopus authored Nov 7, 2024
2 parents 1421629 + 32fbf61 commit b3958ae
Show file tree
Hide file tree
Showing 10 changed files with 51 additions and 65 deletions.
Binary file modified public/docs/deployments/kubernetes/helm-update/helm-feed.png
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.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified public/docs/shared-content/releases/images/create-release.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
26 changes: 10 additions & 16 deletions src/pages/docs/kubernetes/steps/helm.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,12 @@
---
layout: src/layouts/Default.astro
pubDate: 2023-01-01
modDate: 2024-09-13
modDate: 2024-11-07
title: Deploy a Helm chart
description: Deploy a Helm chart to a Kubernetes cluster.
navOrder: 30
---

:::div{.hint}
`Upgrade a Helm Chart` was renamed to `Deploy a Helm chart` in the Octopus Deploy 2024.1 release. The functionality remains the same. This is only a name change to make our terminology clearer.
:::

Helm Charts are like a package manager for Kubernetes applications, allowing users to reuse and share complex resource configurations.

## Helm chart sources
Expand Down Expand Up @@ -51,10 +47,6 @@ For more information about Helm Chart repositories and how to run your own priva

### OCI-based registry feed

:::div{.info}
Octopus version `2023.3.4127` added support for Helm repositories stored in OCI-based registries.
:::

The Open Container Initiative (OCI) is a lightweight, open governance structure (project), formed under the auspices of the Linux Foundation, for the express purpose of creating open industry standards around container formats and runtimes

An OCI-based registry can contain zero or more Helm repositories and each of those repositories can contain zero or more packaged Helm charts.
Expand All @@ -67,12 +59,6 @@ For more information about using OCI-based registries and how to run your own pr

### Git repository

:::div{.info}
Octopus version `2024.1` added support for Helm charts stored in Git repositories.

You can find more information about this feature in this [blog post on using Git resources directly in deployments](https://octopus.com/blog/git-resources-in-deployments).
:::

Sourcing your Helm charts from a Git Repository can streamline your deployment process by reducing the amount of steps required to get them into Octopus.

To configure a Git Repository source, select the `Git Repository` option as your Chart Source.
Expand Down Expand Up @@ -202,5 +188,13 @@ To ensure a smooth deployment experience, we recommend setting a larger Octopus

## Learn more

- Generate an Octopus guide for [Kubernetes and the rest of your CI/CD pipeline](https://octopus.com/docs/guides?destination=Kubernetes)
- [Kubernetes blog posts](https://octopus.com/blog/tag/kubernetes)

:::div{.hint}
**Step updates**
**2024.1:**
- `Upgrade a Helm Chart` was renamed to `Deploy a Helm chart`.
- Support was added for Helm charts stored in Git repositories. You can learn more in [this blog post](https://octopus.com/blog/git-resources-in-deployments).
**2023.3.4127**
- Support was added for Helm repositories stored in OCI-based registries.
:::
13 changes: 7 additions & 6 deletions src/pages/docs/kubernetes/steps/kubernetes-ingress.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,12 @@
---
layout: src/layouts/Default.astro
pubDate: 2023-01-01
modDate: 2024-07-31
modDate: 2024-11-07
title: Configure and apply a Kubernetes Ingress
description: Configure and apply a Kubernetes Ingress.
navOrder: 70
---

:::div{.hint}
`Deploy Kubernetes ingress resource` was renamed to `Configure and apply a Kubernetes Ingress` in the Octopus Deploy 2024.1 release. The functionality remains the same. This is only a name change to make our terminology clearer.
:::

[Ingress resources](https://oc.to/KubernetesIngressResource) provide a way to direct HTTP traffic to service resources based on the requested host and path.

## Ingress name
Expand Down Expand Up @@ -79,5 +75,10 @@ When there are no matching ingress rules, traffic can be sent to the service con

## Learn more

- Generate an Octopus guide for [Kubernetes and the rest of your CI/CD pipeline](https://octopus.com/docs/guides?destination=Kubernetes)
- [Kubernetes blog posts](https://octopus.com/blog/tag/kubernetes)

:::div{.hint}
**Step updates**
**2024.1:**
- `Deploy Kubernetes ingress resource` was renamed to `Configure and apply a Kubernetes Ingress`.
:::
13 changes: 7 additions & 6 deletions src/pages/docs/kubernetes/steps/kubernetes-resources.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,12 @@
---
layout: src/layouts/Default.astro
pubDate: 2023-01-01
modDate: 2024-07-31
modDate: 2024-11-07
title: Configure and apply Kubernetes resources
description: Configure and apply Kubernetes resources.
navOrder: 50
---

:::div{.hint}
`Deploy Kubernetes containers` was renamed to `Configure and apply Kubernetes resources` in the Octopus Deploy 2024.1 release. The functionality remains the same. This is only a name change to make our terminology clearer.
:::

Octopus supports the deployment of Kubernetes resources through the `Configure and apply Kubernetes resources` step. This step exposes a UI that builds up a [Kubernetes Deployment resource](https://oc.to/KubernetesDeploymentResource), a [Service resource](https://oc.to/KubernetesServiceResource), and an [Ingress resource](https://oc.to/KubernetesIngressResource). The combination of these resources represents an opinionated view about what makes up a typical Kubernetes deployment.

## Configure and apply Kubernetes resources step
Expand Down Expand Up @@ -1053,5 +1049,10 @@ For example, to change the name assigned to the ConfigMap resource to include th

## Learn more

- Generate an Octopus guide for [Kubernetes and the rest of your CI/CD pipeline](https://octopus.com/docs/guides?destination=Kubernetes)
- [Kubernetes blog posts](https://octopus.com/blog/tag/kubernetes)

:::div{.hint}
**Step updates**
**2024.1:**
- `Deploy Kubernetes containers` was renamed to `Configure and apply Kubernetes resources`.
:::
13 changes: 7 additions & 6 deletions src/pages/docs/kubernetes/steps/kubernetes-service.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,12 @@
---
layout: src/layouts/Default.astro
pubDate: 2023-01-01
modDate: 2024-07-31
modDate: 2024-11-07
title: Configure and apply a Kubernetes Service
description: Configure and apply a Kubernetes Service.
navOrder: 60
---

:::div{.hint}
`Deploy Kubernetes service resource` was renamed to `Configure and apply a Kubernetes Service` in the Octopus Deploy 2024.1 release. The functionality remains the same. This is only a name change to make our terminology clearer.
:::

[Service resources](https://oc.to/KubernetesServiceResource), expose Pod resources either internally within Kubernetes cluster, or externally to public clients. The `Configure and apply a Kubernetes Service` steps can be used to configure and deploy a Service resource.

## Service name
Expand Down Expand Up @@ -79,5 +75,10 @@ There are some advanced use cases where creating a Service resource without sele

## Learn more

- Generate an Octopus guide for [Kubernetes and the rest of your CI/CD pipeline](https://octopus.com/docs/guides?destination=Kubernetes)
- [Kubernetes blog posts](https://octopus.com/blog/tag/kubernetes)

:::div{.hint}
**Step updates**
**2024.1:**
- `Deploy Kubernetes service resource` was renamed to `Configure and apply a Kubernetes Service`.
:::
22 changes: 9 additions & 13 deletions src/pages/docs/kubernetes/steps/kustomize.mdx
Original file line number Diff line number Diff line change
@@ -1,33 +1,23 @@
---
layout: src/layouts/Default.astro
pubDate: 2023-01-01
modDate: 2024-07-31
modDate: 2024-11-07
title: Deploy with Kustomize
description: Use Deploy with Kustomize to deploy resources to a Kubernetes cluster.
navOrder: 40
---

import Image from "src/components/Image.astro";

:::div{.hint}
`Kustomize` was renamed to `Deploy with Kustomize` in the Octopus Deploy 2024.1 release. The functionality remains the same. This is only a name change to make our terminology clearer.
:::

Octopus supports the deployment of Kubernetes resources through the `Deploy with Kustomize` step.

This step lets you source your **Kustomize** files from git, perform variable substitutions based on your environment and/or tenant and apply the changes to your Kubernetes clusters.

[Kustomize](https://kustomize.io) introduces a template-free way to customize application configuration that simplifies the use of off-the-shelf applications.

:::div{.info}
From Octopus **2024.1**, if you are storing your project configuration in a Git repository using the [Configuration as code feature](/docs/projects/version-control), you can source your Kustomize files from the same Git repository as your deployment process by selecting Project as the Git repository source. When creating a Release, the commit hash used for your deployment process will also be used to source the Kustomize files.

You can find more information about this feature in this [blog post on using Git resources directly in deployments](https://octopus.com/blog/git-resources-in-deployments).
:::
## Recommended step usages

## Recommended usages for this step

We list a few different scenarios below to help you figure out what is the best setup for you to deploy your applications to a Kubernetes cluster with Octopus.
We list a few scenarios below to help you figure out what is the best setup for you to deploy your applications to a Kubernetes cluster with Octopus.

### When you use Kustomize for one application configuration

Expand Down Expand Up @@ -99,3 +89,9 @@ images:
The "`#{Octopus.Action.Package[nginx].PackageVersion}`" Octostache expression will be resolved to the selected image version during the deployment.

:::div{.hint}
**Step updates**
**2024.1:**
- `Kustomize` was renamed to `Deploy with Kustomize`.
- If you store your project configuration in a Git repository using the [Configuration as code feature](/docs/projects/version-control), you can source your Kustomize files from the same Git repository as your deployment process by selecting Project as the Git repository source. When creating a Release, the commit hash used for your deployment process will also be used to source the Kustomize files. You can learn more in [this blog post](https://octopus.com/blog/git-resources-in-deployments).
:::
29 changes: 11 additions & 18 deletions src/pages/docs/kubernetes/steps/yaml.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,12 @@
---
layout: src/layouts/Default.astro
pubDate: 2023-07-28
modDate: 2024-07-31
modDate: 2024-11-07
title: Deploy Kubernetes YAML
description: Deploy Kubernetes YAML.
navOrder: 20
---

:::div{.hint}
`Deploy Raw Kubernetes YAML` was renamed to `Deploy Kubernetes YAML` in the Octopus Deploy 2024.1 release. The functionality remains the same. This is only a name change to make our terminology clearer.
:::

Octopus supports the deployment of Kubernetes resources through the `Deploy Kubernetes YAML` step.

This step lets you configure Kubernetes manually, leveraging the full power of Octopus features to support your setup.
Expand All @@ -26,18 +22,6 @@ You can source your YAML from three different sources:

### Git Repository

:::div{.hint}
Sourcing from Git Repositories was added in Octopus **2023.3**.

You can find more information about this feature in [this blog post](https://octopus.com/blog/manifests-from-git).
:::

:::div{.info}
From Octopus **2024.1**, if you are storing your project configuration in a Git repository using the [Configuration as code feature](/docs/projects/version-control), you can source your YAML from the same Git repository as your deployment process by selecting Project as the Git repository source. When creating a Release, the commit hash used for your deployment process will also be used to source the YAML files.

You can find more information about this feature in this [blog post on using Git resources directly in deployments](https://octopus.com/blog/git-resources-in-deployments).
:::

:::div{.warning}
Sourcing from a Git repository clones the whole repository onto Octopus Server during a deployment. Ensure that you **do not have any sensitive data** in your git repository.
:::
Expand Down Expand Up @@ -74,7 +58,7 @@ To configure a package source, select the `Package` option as your YAML Source.
The simplest way to get going with this step is to use Inline YAML.
You can create your YAML resources in the inline editor which will be saved in the project in Octopus.

To configure an inline YAML source, select the `Inline YAML` as your YAML Source, click `Add Source Code` and start writing!
To configure an inline YAML source, select the `Inline YAML` as your YAML Source.

:::figure
![Deploy Kubernetes YAML with an Inline Script](/docs/deployments/kubernetes/deploy-raw-yaml/inline-yaml.png)
Expand Down Expand Up @@ -126,3 +110,12 @@ There are a few different ways to take advantage of this feature:
**Note:** *If multiple glob patterns find the same file, the file will be applied twice.*

[Learn more about glob patterns](/docs/deployments/kubernetes/glob-patterns).

:::div{.hint}
**Step updates**
**2024.1:**
- `Deploy Raw Kubernetes YAML` was renamed to `Deploy Kubernetes YAML`.
- If you store your project configuration in a Git repository using the [Configuration as code feature](/docs/projects/version-control), you can source your YAML from the same Git repository as your deployment process by selecting Project as the Git repository source. When creating a Release, the commit hash used for your deployment process will also be used to source the YAML files. You can learn more in [this blog post](https://octopus.com/blog/git-resources-in-deployments).
**2023.3:**
- Sourcing from Git Repositories was added. You can learn more in [this blog post](https://octopus.com/blog/manifests-from-git).
:::

0 comments on commit b3958ae

Please sign in to comment.