Merge pull request #1974 from OctopusDeploy/john/verao

src/pages/docs/deployments/kubernetes/deploy-raw-yaml/index.md

@@ -98,52 +98,5 @@ 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.*
 
-### Glob Pattern Cheat Sheet
 
-Patterns are always relative so start them with a file or folder name. eg: `my/folder/*.yml` and `**/dep.yml`.
-
-:::div{.warning}
-Directory separators should be forward slashes `/` for all platforms. Backslashes `\` only work when the server and worker are running on Windows.
-:::
-
-:::div{.hint}
-Glob patterns cannot contain folders stemming from a root directory. eg: `/` and `C:\`
-
-Glob patterns cannot start with a relative path indicator. eg: `./` and `.\`
-
-The directory traversal path `../` is not supported.
-:::
-
-`?` matches any single character in a file or directory name:
-```
-deployments/resource-?.yaml => deployments/resource-1.yaml, deployments/resource-g.yaml
-```
-
-`*` matches zero or more characters in a file or directory name:
-```
-deployments/*.yaml => deployments/anything-here.yaml, deployments/123-another-file.yaml
-*/resource.yaml => deployments/resource.yaml, services/resource.yaml
-```
-
-`**` matches zero or more recursive directories:
-```
-**/resource.yaml => deployments/resource.yaml, services/resource.yaml, deployments/child-folder/resource.yaml
-```
-
-:::div{.hint}
-<span style="font-size:14pt;">**Group pattern matching is coming soon**!</span>
-
-`[123]` matches a set of characters in a name. Syntax is similar to character groups in Regex:
-```
-deployments/resource-[123].yaml => deployments/resource-1.yaml, deployments/resource-2.yaml, deployments/resource-3.yaml
-"deployments/resource-g.yaml" would not match the example glob pattern.
-
-deployments/resource-[1-3].yaml => deployments/resource-1.yaml, deployments/resource-2.yaml, deployments/resource-3.yaml
-"deployments/resource-g.yaml" would not match the example glob pattern.
-```
-
-`{abc,123,xyz}` matches any of the comma separated strings:
-```
-deployments/resource-{123,abc}.yaml => deployments/resource-123.yaml, deployments/resource-abc.yaml
-```
-:::
+[Learn more about glob patterns](/docs/deployments/kubernetes/glob-patterns).

src/pages/docs/deployments/kubernetes/glob-patterns.md

@@ -0,0 +1,39 @@
+---
+layout: src/layouts/Default.astro
+pubDate: 2023-01-01
+modDate: 2023-01-01
+title: Glob Pattern Cheat Sheet  
+description: Learn more about glob patterns usages.
+navOrder: 90
+---
+
+
+Patterns are always relative so start them with a file or folder name. eg: `my/folder/*.yml` and `**/dep.yml`.
+
+:::div{.warning}
+Directory separators should be forward slashes `/` for all platforms. Backslashes `\` only work when the server and worker are running on Windows.
+:::
+
+:::div{.hint}
+Glob patterns cannot contain folders stemming from a root directory. eg: `/` and `C:\`
+
+Glob patterns cannot start with a relative path indicator. eg: `./` and `.\`
+
+The directory traversal path `../` is not supported.
+:::
+
+`?` matches any single character in a file or directory name:
+```
+deployments/resource-?.yaml => deployments/resource-1.yaml, deployments/resource-g.yaml
+```
+
+`*` matches zero or more characters in a file or directory name:
+```
+deployments/*.yaml => deployments/anything-here.yaml, deployments/123-another-file.yaml
+*/resource.yaml => deployments/resource.yaml, services/resource.yaml
+```
+
+`**` matches zero or more recursive directories:
+```
+**/resource.yaml => deployments/resource.yaml, services/resource.yaml, deployments/child-folder/resource.yaml
+```

src/pages/docs/deployments/kubernetes/kubectl/index.md

@@ -9,6 +9,6 @@ navOrder: 100
 
 The [kubectl command-line tool](https://kubernetes.io/docs/reference/kubectl/overview/) is required by Octopus Deploy's Kubernetes features.
 
-kubectl is not bundled with Octopus, and must be pre-installed on the [worker](/docs/infrastructure/workers/) or Octopus Server which will execute steps and health checks against a [Kubernetes target](/docs/infrastructure/deployment-targets/kubernetes-target/). Alternatively, [execution containers](/docs/projects/steps/execution-containers-for-workers) may be used. 
+kubectl is not bundled with Octopus, and must be pre-installed on the [worker](/docs/infrastructure/workers/) or Octopus Server which will execute steps and health checks against a [Kubernetes target](/docs/infrastructure/deployment-targets/kubernetes-target/). Alternatively, [execution containers](/docs/projects/steps/execution-containers-for-workers) may be used and we recommend using `[octopuslabs/k8s-workertools](https://hub.docker.com/r/octopuslabs/k8s-workertools)` docker image, we also recommend setting the tag to a version that is compatible with the version of your cluster, [read the official version skew policy](https://kubernetes.io/releases/version-skew-policy/#kubectl) for more information.
 
 By default, Octopus assumes `kubectl` is available in the PATH environment variable. A specific location for `kubectl` can be supplied by setting a `Octopus.Action.Kubernetes.CustomKubectlExecutable` variable in the Octopus project (an example value is `c:\tools\kubectl\version\kubectl.exe`). 

src/pages/docs/deployments/kubernetes/kustomize/index.md

@@ -0,0 +1,57 @@
+---
+layout: src/layouts/Default.astro
+pubDate: 2023-01-01
+modDate: 2023-01-01
+title: kustomize  
+description: Use kustomize to deploy resources to a Kubernetes cluster.
+navOrder: 9
+---
+
+Octopus supports the deployment of Kubernetes resources through the **kustomize** step.
+
+This step allows you to source your **kustomize** files from git, perform variable substitutions based on your environment and/or tenant and finally 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.
+
+## 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.
+
+### When you use Kustomize for one application configuration
+
+1. **Multiple overlays**  
+   This is the recommended usage if you are already using Kustomize and just want Octopus to orchestrate the deployment.
+   In this scenario, our recommendation is to use `.env` files with Octopus [variable substitution syntax](/docs/projects/variables/variable-substitutions), so we can replace secrets and any other data managed via Octopus variables. These `.env` files are then used by [secretGenerator](https://kubectl.docs.kubernetes.io/references/kustomize/builtins/#_secretgenerator_) and/or [configMapGenerator](https://kubectl.docs.kubernetes.io/references/kustomize/builtins/#_configmapgenerator_).  
+   Everything else is defined in the `kustomization.yaml` files directly, and overlays should match the same environment structure defined in Octopus itself. 
+
+2. **Single overlay for Octopus**  
+   In this scenario, you may define two overlays, one being for local use outside Octopus, so you can test your `yaml` files. The other overlay is used exclusively by Octopus.  
+   In the Octopus overlay, you add [variable substitution syntax](/docs/projects/variables/variable-substitutions) directly into `kustomization.yaml` and any other `yaml` files in the overlay folder, as well as `.env` files.  
+   This scenario is better suited for customers with many environments and/or tenants, where customisations are needed for each target.
+
+3. **A mix of both**  
+   This would be the ideal scenario when you have a small number of environments and many tenants.  
+   In this scenario, you model your overlays based on the environments, with the different settings hardcoded in the `kustomization.yaml` file, and you use Octopus [substitution syntax](/docs/projects/variables/variable-substitutions) to define the different tenant properties in `kustomization.yaml` file.  
+   Again as in the previous scenarios, we would use `.env` files for secrets via [secretGenerator](https://kubectl.docs.kubernetes.io/references/kustomize/builtins/#_secretgenerator_).
+
+### When you use Kustomize to template configurations for many applications
+
+1. **A mix of both — templates**  
+   You can go beyond configuration for a single application with Octopus and Kustomize. Imagine you have a hundred applications you deploy to Kubernetes. Some of them might have universal traits, like a group of API applications or a group of databases. Therefore, parts of the configuration will be universal for all the apps or a group of apps. There likely be app-unique parameters (like a container image).  
+   You can combine overlays and Octopus variables to create and use one template for all the apps. In this scenario, you would have a set of base files same for all the apps. One or more levels of overlays to add customizations for an app group. You can introduce another layer of overlays for environments. Finally, app-specific parameters (e.g. container images, tags and labels) can be defined in Octopus variables.  
+   In this scenario, tenant or environment-specific parameters can be added to any overlay. For example, you can add prefixes for tenants; also consider using [system variables](/docs/projects/variables/system-variables).
+
+## Kustomization file directory
+
+This field must be a path to a directory containing the `kustomization.yaml` file.
+During deployment, **Kustomize** reads the `kustomization.yaml` file located at this path to perform manifest yaml transforms.  
+The path is relative to the root of the git repository.
+When using overlays, ensure the path is to the overlay directory containing `kustomization.yaml` file.  
+Also, remember that in Linux workers, the paths are case-sensitive, so it is always good practice to check this. 
+
+## Substitute Variables in Files
+
+This setting is useful, for example, when you want to put your application specific configuration settings in a `.env` file and also have the value scoped per environment and/or tenant, see more information regarding [variable scoping](/docs/projects/variables#scoping-variables).  
+The target file paths are relative to the root of the git repository.
+Again remember that in Linux workers, paths are case-sensitive, so it is always good practice to check this.  
+You can use glob patterns to target multiple files. [Learn more about glob patterns](/docs/deployments/kubernetes/glob-patterns).