Fixing {name} using code snippets
This commit is contained in:
parent
2f4bb3ab0b
commit
7e10b1ac6b
|
|
@ -26,7 +26,7 @@ The following files are looked for to determine the how the resources will be de
|
|||
| **kustomization.yaml**:| / relative to `path` or custom path from `fleet.yaml` | The resources will be deployed using Kustomize. Refer to the `fleet.yaml` for more options. |
|
||||
| **fleet.yaml** | Any subpath | If any fleet.yaml is found a new [bundle](./concepts.md) will be defined. This allows mixing charts, kustomize, and raw YAML in the same repo |
|
||||
| ** *.yaml ** | Any subpath | If a `Chart.yaml` or `kustomization.yaml` is not found then any `.yaml` or `.yml` file will be assumed to be a Kubernetes resource and will be deployed. |
|
||||
| **overlays/{name}** | / relative to `path` | When deploying using raw YAML (not Kustomize or Helm) `overlays` is a special directory for customizations. |
|
||||
| **overlays/`{name}`** | / relative to `path` | When deploying using raw YAML (not Kustomize or Helm) `overlays` is a special directory for customizations. |
|
||||
|
||||
### Alternative scan, explicitly defined by the user
|
||||
In addition to the previously described method, Fleet also supports a more direct, user-driven approach for defining Bundles.
|
||||
|
|
|
|||
|
|
@ -348,7 +348,7 @@ BundleDeploymentList contains a list of BundleDeployment
|
|||
| helm | Helm options for the deployment, like the chart name, repo and values. | *[HelmOptions](#helmoptions) | false |
|
||||
| serviceAccount | ServiceAccount which will be used to perform this deployment. | string | false |
|
||||
| forceSyncGeneration | ForceSyncGeneration is used to force a redeployment | int64 | false |
|
||||
| yaml | YAML options, if using raw YAML these are names that map to overlays/{name} files that will be used to replace or patch a resource. | *[YAMLOptions](#yamloptions) | false |
|
||||
| yaml | YAML options, if using raw YAML these are names that map to overlays/`{name}` files that will be used to replace or patch a resource. | *[YAMLOptions](#yamloptions) | false |
|
||||
| diff | Diff can be used to ignore the modified state of objects which are amended at runtime. | *[DiffOptions](#diffoptions) | false |
|
||||
| keepResources | KeepResources can be used to keep the deployed resources when removing the bundle | bool | false |
|
||||
| deleteNamespace | DeleteNamespace can be used to delete the deployed namespace when removing the bundle | bool | false |
|
||||
|
|
@ -570,7 +570,7 @@ Define helm values that can come from configmap, secret or external. Credit: htt
|
|||
|
||||
#### YAMLOptions
|
||||
|
||||
YAMLOptions, if using raw YAML these are names that map to overlays/{name} files that will be used to replace or patch a resource.
|
||||
YAMLOptions, if using raw YAML these are names that map to overlays/`{name}` files that will be used to replace or patch a resource.
|
||||
|
||||
| Field | Description | Scheme | Required |
|
||||
| ----- | ----------- | ------ | -------- |
|
||||
|
|
|
|||
|
|
@ -26,7 +26,7 @@ The following files are looked for to determine the how the resources will be de
|
|||
| **kustomization.yaml**:| / relative to `path` or custom path from `fleet.yaml` | The resources will be deployed using Kustomize. Refer to the `fleet.yaml` for more options. |
|
||||
| **fleet.yaml** | Any subpath | If any fleet.yaml is found a new [bundle](./concepts.md) will be defined. This allows mixing charts, kustomize, and raw YAML in the same repo |
|
||||
| ** *.yaml ** | Any subpath | If a `Chart.yaml` or `kustomization.yaml` is not found then any `.yaml` or `.yml` file will be assumed to be a Kubernetes resource and will be deployed. |
|
||||
| **overlays/{name}** | / relative to `path` | When deploying using raw YAML (not Kustomize or Helm) `overlays` is a special directory for customizations. |
|
||||
| **overlays/`{name}`** | / relative to `path` | When deploying using raw YAML (not Kustomize or Helm) `overlays` is a special directory for customizations. |
|
||||
|
||||
### Excluding files and directories from bundles
|
||||
|
||||
|
|
|
|||
|
|
@ -348,7 +348,7 @@ BundleDeploymentList contains a list of BundleDeployment
|
|||
| helm | Helm options for the deployment, like the chart name, repo and values. | *[HelmOptions](#helmoptions) | false |
|
||||
| serviceAccount | ServiceAccount which will be used to perform this deployment. | string | false |
|
||||
| forceSyncGeneration | ForceSyncGeneration is used to force a redeployment | int64 | false |
|
||||
| yaml | YAML options, if using raw YAML these are names that map to overlays/{name} files that will be used to replace or patch a resource. | *[YAMLOptions](#yamloptions) | false |
|
||||
| yaml | YAML options, if using raw YAML these are names that map to overlays/`{name}` files that will be used to replace or patch a resource. | *[YAMLOptions](#yamloptions) | false |
|
||||
| diff | Diff can be used to ignore the modified state of objects which are amended at runtime. | *[DiffOptions](#diffoptions) | false |
|
||||
| keepResources | KeepResources can be used to keep the deployed resources when removing the bundle | bool | false |
|
||||
| deleteNamespace | DeleteNamespace can be used to delete the deployed namespace when removing the bundle | bool | false |
|
||||
|
|
@ -569,7 +569,7 @@ Define helm values that can come from configmap, secret or external. Credit: htt
|
|||
|
||||
#### YAMLOptions
|
||||
|
||||
YAMLOptions, if using raw YAML these are names that map to overlays/{name} files that will be used to replace or patch a resource.
|
||||
YAMLOptions, if using raw YAML these are names that map to overlays/`{name}` files that will be used to replace or patch a resource.
|
||||
|
||||
| Field | Description | Scheme | Required |
|
||||
| ----- | ----------- | ------ | -------- |
|
||||
|
|
|
|||
|
|
@ -26,7 +26,7 @@ The following files are looked for to determine the how the resources will be de
|
|||
| **kustomization.yaml**:| / relative to `path` or custom path from `fleet.yaml` | The resources will be deployed using Kustomize. Refer to the `fleet.yaml` for more options. |
|
||||
| **fleet.yaml** | Any subpath | If any fleet.yaml is found a new [bundle](./concepts.md) will be defined. This allows mixing charts, kustomize, and raw YAML in the same repo |
|
||||
| ** *.yaml ** | Any subpath | If a `Chart.yaml` or `kustomization.yaml` is not found then any `.yaml` or `.yml` file will be assumed to be a Kubernetes resource and will be deployed. |
|
||||
| **overlays/{name}** | / relative to `path` | When deploying using raw YAML (not Kustomize or Helm) `overlays` is a special directory for customizations. |
|
||||
| **overlays/`{name}`** | / relative to `path` | When deploying using raw YAML (not Kustomize or Helm) `overlays` is a special directory for customizations. |
|
||||
|
||||
### Excluding files and directories from bundles
|
||||
|
||||
|
|
|
|||
|
|
@ -348,7 +348,7 @@ BundleDeploymentList contains a list of BundleDeployment
|
|||
| helm | Helm options for the deployment, like the chart name, repo and values. | *[HelmOptions](#helmoptions) | false |
|
||||
| serviceAccount | ServiceAccount which will be used to perform this deployment. | string | false |
|
||||
| forceSyncGeneration | ForceSyncGeneration is used to force a redeployment | int64 | false |
|
||||
| yaml | YAML options, if using raw YAML these are names that map to overlays/{name} files that will be used to replace or patch a resource. | *[YAMLOptions](#yamloptions) | false |
|
||||
| yaml | YAML options, if using raw YAML these are names that map to overlays/`{name}` files that will be used to replace or patch a resource. | *[YAMLOptions](#yamloptions) | false |
|
||||
| diff | Diff can be used to ignore the modified state of objects which are amended at runtime. | *[DiffOptions](#diffoptions) | false |
|
||||
| keepResources | KeepResources can be used to keep the deployed resources when removing the bundle | bool | false |
|
||||
| deleteNamespace | DeleteNamespace can be used to delete the deployed namespace when removing the bundle | bool | false |
|
||||
|
|
@ -570,7 +570,7 @@ Define helm values that can come from configmap, secret or external. Credit: htt
|
|||
|
||||
#### YAMLOptions
|
||||
|
||||
YAMLOptions, if using raw YAML these are names that map to overlays/{name} files that will be used to replace or patch a resource.
|
||||
YAMLOptions, if using raw YAML these are names that map to overlays/`{name}` files that will be used to replace or patch a resource.
|
||||
|
||||
| Field | Description | Scheme | Required |
|
||||
| ----- | ----------- | ------ | -------- |
|
||||
|
|
|
|||
|
|
@ -26,7 +26,7 @@ The following files are looked for to determine the how the resources will be de
|
|||
| **kustomization.yaml**:| / relative to `path` or custom path from `fleet.yaml` | The resources will be deployed using Kustomize. Refer to the `fleet.yaml` for more options. |
|
||||
| **fleet.yaml** | Any subpath | If any fleet.yaml is found a new [bundle](./concepts.md) will be defined. This allows mixing charts, kustomize, and raw YAML in the same repo |
|
||||
| ** *.yaml ** | Any subpath | If a `Chart.yaml` or `kustomization.yaml` is not found then any `.yaml` or `.yml` file will be assumed to be a Kubernetes resource and will be deployed. |
|
||||
| **overlays/{name}** | / relative to `path` | When deploying using raw YAML (not Kustomize or Helm) `overlays` is a special directory for customizations. |
|
||||
| **overlays/`{name}`** | / relative to `path` | When deploying using raw YAML (not Kustomize or Helm) `overlays` is a special directory for customizations. |
|
||||
|
||||
### Excluding files and directories from bundles
|
||||
|
||||
|
|
|
|||
|
|
@ -348,7 +348,7 @@ BundleDeploymentList contains a list of BundleDeployment
|
|||
| helm | Helm options for the deployment, like the chart name, repo and values. | *[HelmOptions](#helmoptions) | false |
|
||||
| serviceAccount | ServiceAccount which will be used to perform this deployment. | string | false |
|
||||
| forceSyncGeneration | ForceSyncGeneration is used to force a redeployment | int64 | false |
|
||||
| yaml | YAML options, if using raw YAML these are names that map to overlays/{name} files that will be used to replace or patch a resource. | *[YAMLOptions](#yamloptions) | false |
|
||||
| yaml | YAML options, if using raw YAML these are names that map to overlays/`{name}` files that will be used to replace or patch a resource. | *[YAMLOptions](#yamloptions) | false |
|
||||
| diff | Diff can be used to ignore the modified state of objects which are amended at runtime. | *[DiffOptions](#diffoptions) | false |
|
||||
| keepResources | KeepResources can be used to keep the deployed resources when removing the bundle | bool | false |
|
||||
| deleteNamespace | DeleteNamespace can be used to delete the deployed namespace when removing the bundle | bool | false |
|
||||
|
|
@ -570,7 +570,7 @@ Define helm values that can come from configmap, secret or external. Credit: htt
|
|||
|
||||
#### YAMLOptions
|
||||
|
||||
YAMLOptions, if using raw YAML these are names that map to overlays/{name} files that will be used to replace or patch a resource.
|
||||
YAMLOptions, if using raw YAML these are names that map to overlays/`{name}` files that will be used to replace or patch a resource.
|
||||
|
||||
| Field | Description | Scheme | Required |
|
||||
| ----- | ----------- | ------ | -------- |
|
||||
|
|
|
|||
|
|
@ -26,7 +26,7 @@ The following files are looked for to determine the how the resources will be de
|
|||
| **kustomization.yaml**:| / relative to `path` or custom path from `fleet.yaml` | The resources will be deployed using Kustomize. Refer to the `fleet.yaml` for more options. |
|
||||
| **fleet.yaml** | Any subpath | If any fleet.yaml is found a new [bundle](./concepts.md) will be defined. This allows mixing charts, kustomize, and raw YAML in the same repo |
|
||||
| ** *.yaml ** | Any subpath | If a `Chart.yaml` or `kustomization.yaml` is not found then any `.yaml` or `.yml` file will be assumed to be a Kubernetes resource and will be deployed. |
|
||||
| **overlays/{name}** | / relative to `path` | When deploying using raw YAML (not Kustomize or Helm) `overlays` is a special directory for customizations. |
|
||||
| **overlays/`{name}`** | / relative to `path` | When deploying using raw YAML (not Kustomize or Helm) `overlays` is a special directory for customizations. |
|
||||
|
||||
## `fleet.yaml`
|
||||
|
||||
|
|
|
|||
|
|
@ -26,7 +26,7 @@ The following files are looked for to determine the how the resources will be de
|
|||
| **kustomization.yaml**:| / relative to `path` or custom path from `fleet.yaml` | The resources will be deployed using Kustomize. Refer to the `fleet.yaml` for more options. |
|
||||
| **fleet.yaml** | Any subpath | If any fleet.yaml is found a new [bundle](./concepts.md) will be defined. This allows mixing charts, kustomize, and raw YAML in the same repo |
|
||||
| ** *.yaml ** | Any subpath | If a `Chart.yaml` or `kustomization.yaml` is not found then any `.yaml` or `.yml` file will be assumed to be a Kubernetes resource and will be deployed. |
|
||||
| **overlays/{name}** | / relative to `path` | When deploying using raw YAML (not Kustomize or Helm) `overlays` is a special directory for customizations. |
|
||||
| **overlays/`{name}`** | / relative to `path` | When deploying using raw YAML (not Kustomize or Helm) `overlays` is a special directory for customizations. |
|
||||
|
||||
## `fleet.yaml`
|
||||
|
||||
|
|
|
|||
|
|
@ -39,7 +39,7 @@ The following files are looked for to determine the how the resources will be de
|
|||
| **kustomization.yaml**:| / relative to `path` or custom path from `fleet.yaml` | The resources will be deployed using Kustomize. Refer to the `fleet.yaml` for more options. |
|
||||
| **fleet.yaml** | Any subpath | If any fleet.yaml is found a new [bundle](./concepts.md) will be defined. This allows mixing charts, kustomize, and raw YAML in the same repo |
|
||||
| ** *.yaml ** | Any subpath | If a `Chart.yaml` or `kustomization.yaml` is not found then any `.yaml` or `.yml` file will be assumed to be a Kubernetes resource and will be deployed. |
|
||||
| **overlays/{name}** | / relative to `path` | When deploying using raw YAML (not Kustomize or Helm) `overlays` is a special directory for customizations. |
|
||||
| **overlays/`{name}`** | / relative to `path` | When deploying using raw YAML (not Kustomize or Helm) `overlays` is a special directory for customizations. |
|
||||
|
||||
## `fleet.yaml`
|
||||
|
||||
|
|
|
|||
|
|
@ -272,7 +272,7 @@
|
|||
| helm | Helm options for the deployment, like the chart name, repo and values. | *[HelmOptions](#helmoptions) | false |
|
||||
| serviceAccount | ServiceAccount which will be used to perform this deployment. | string | false |
|
||||
| forceSyncGeneration | ForceSyncGeneration is used to force a redeployment | int64 | false |
|
||||
| yaml | YAML options, if using raw YAML these are names that map to overlays/{name} that will be used to replace or patch a resource. | *[YAMLOptions](#yamloptions) | false |
|
||||
| yaml | YAML options, if using raw YAML these are names that map to overlays/`{name}` that will be used to replace or patch a resource. | *[YAMLOptions](#yamloptions) | false |
|
||||
| diff | Diff can be used to ignore the modified state of objects which are amended at runtime. | *[DiffOptions](#diffoptions) | false |
|
||||
| keepResources | KeepResources can be used to keep the deployed resources when removing the bundle | bool | false |
|
||||
|
||||
|
|
|
|||
|
|
@ -26,7 +26,7 @@ The following files are looked for to determine the how the resources will be de
|
|||
| **kustomization.yaml**:| / relative to `path` or custom path from `fleet.yaml` | The resources will be deployed using Kustomize. Refer to the `fleet.yaml` for more options. |
|
||||
| **fleet.yaml** | Any subpath | If any fleet.yaml is found a new [bundle](./concepts.md) will be defined. This allows mixing charts, kustomize, and raw YAML in the same repo |
|
||||
| ** *.yaml ** | Any subpath | If a `Chart.yaml` or `kustomization.yaml` is not found then any `.yaml` or `.yml` file will be assumed to be a Kubernetes resource and will be deployed. |
|
||||
| **overlays/{name}** | / relative to `path` | When deploying using raw YAML (not Kustomize or Helm) `overlays` is a special directory for customizations. |
|
||||
| **overlays/`{name}`** | / relative to `path` | When deploying using raw YAML (not Kustomize or Helm) `overlays` is a special directory for customizations. |
|
||||
|
||||
## `fleet.yaml`
|
||||
|
||||
|
|
|
|||
|
|
@ -273,7 +273,7 @@
|
|||
| helm | Helm options for the deployment, like the chart name, repo and values. | *[HelmOptions](#helmoptions) | false |
|
||||
| serviceAccount | ServiceAccount which will be used to perform this deployment. | string | false |
|
||||
| forceSyncGeneration | ForceSyncGeneration is used to force a redeployment | int64 | false |
|
||||
| yaml | YAML options, if using raw YAML these are names that map to overlays/{name} that will be used to replace or patch a resource. | *[YAMLOptions](#yamloptions) | false |
|
||||
| yaml | YAML options, if using raw YAML these are names that map to overlays/`{name}` that will be used to replace or patch a resource. | *[YAMLOptions](#yamloptions) | false |
|
||||
| diff | Diff can be used to ignore the modified state of objects which are amended at runtime. | *[DiffOptions](#diffoptions) | false |
|
||||
| keepResources | KeepResources can be used to keep the deployed resources when removing the bundle | bool | false |
|
||||
|
||||
|
|
|
|||
|
|
@ -26,7 +26,7 @@ The following files are looked for to determine the how the resources will be de
|
|||
| **kustomization.yaml**:| / relative to `path` or custom path from `fleet.yaml` | The resources will be deployed using Kustomize. Refer to the `fleet.yaml` for more options. |
|
||||
| **fleet.yaml** | Any subpath | If any fleet.yaml is found a new [bundle](./concepts.md) will be defined. This allows mixing charts, kustomize, and raw YAML in the same repo |
|
||||
| ** *.yaml ** | Any subpath | If a `Chart.yaml` or `kustomization.yaml` is not found then any `.yaml` or `.yml` file will be assumed to be a Kubernetes resource and will be deployed. |
|
||||
| **overlays/{name}** | / relative to `path` | When deploying using raw YAML (not Kustomize or Helm) `overlays` is a special directory for customizations. |
|
||||
| **overlays/`{name}`** | / relative to `path` | When deploying using raw YAML (not Kustomize or Helm) `overlays` is a special directory for customizations. |
|
||||
|
||||
### Excluding files and directories from bundles
|
||||
|
||||
|
|
|
|||
|
|
@ -289,7 +289,7 @@ BundleDeployment is used internally by Fleet and should not be used directly. Wh
|
|||
| helm | Helm options for the deployment, like the chart name, repo and values. | *[HelmOptions](#helmoptions) | false |
|
||||
| serviceAccount | ServiceAccount which will be used to perform this deployment. | string | false |
|
||||
| forceSyncGeneration | ForceSyncGeneration is used to force a redeployment | int64 | false |
|
||||
| yaml | YAML options, if using raw YAML these are names that map to overlays/{name} files that will be used to replace or patch a resource. | *[YAMLOptions](#yamloptions) | false |
|
||||
| yaml | YAML options, if using raw YAML these are names that map to overlays/`{name}` files that will be used to replace or patch a resource. | *[YAMLOptions](#yamloptions) | false |
|
||||
| diff | Diff can be used to ignore the modified state of objects which are amended at runtime. | *[DiffOptions](#diffoptions) | false |
|
||||
| keepResources | KeepResources can be used to keep the deployed resources when removing the bundle | bool | false |
|
||||
| ignore | IgnoreOptions can be used to ignore fields when monitoring the bundle. | [IgnoreOptions](#ignoreoptions) | false |
|
||||
|
|
@ -715,7 +715,7 @@ Define helm values that can come from configmap, secret or external. Credit: htt
|
|||
|
||||
#### YAMLOptions
|
||||
|
||||
YAMLOptions, if using raw YAML these are names that map to overlays/{name} files that will be used to replace or patch a resource.
|
||||
YAMLOptions, if using raw YAML these are names that map to overlays/`{name}` files that will be used to replace or patch a resource.
|
||||
|
||||
| Field | Description | Scheme | Required |
|
||||
| ----- | ----------- | ------ | -------- |
|
||||
|
|
|
|||
|
|
@ -26,7 +26,7 @@ The following files are looked for to determine the how the resources will be de
|
|||
| **kustomization.yaml**:| / relative to `path` or custom path from `fleet.yaml` | The resources will be deployed using Kustomize. Refer to the `fleet.yaml` for more options. |
|
||||
| **fleet.yaml** | Any subpath | If any fleet.yaml is found a new [bundle](./concepts.md) will be defined. This allows mixing charts, kustomize, and raw YAML in the same repo |
|
||||
| ** *.yaml ** | Any subpath | If a `Chart.yaml` or `kustomization.yaml` is not found then any `.yaml` or `.yml` file will be assumed to be a Kubernetes resource and will be deployed. |
|
||||
| **overlays/{name}** | / relative to `path` | When deploying using raw YAML (not Kustomize or Helm) `overlays` is a special directory for customizations. |
|
||||
| **overlays/`{name}`** | / relative to `path` | When deploying using raw YAML (not Kustomize or Helm) `overlays` is a special directory for customizations. |
|
||||
|
||||
### Excluding files and directories from bundles
|
||||
|
||||
|
|
|
|||
|
|
@ -309,7 +309,7 @@ BundleDeployment is used internally by Fleet and should not be used directly. Wh
|
|||
| helm | Helm options for the deployment, like the chart name, repo and values. | *[HelmOptions](#helmoptions) | false |
|
||||
| serviceAccount | ServiceAccount which will be used to perform this deployment. | string | false |
|
||||
| forceSyncGeneration | ForceSyncGeneration is used to force a redeployment | int64 | false |
|
||||
| yaml | YAML options, if using raw YAML these are names that map to overlays/{name} files that will be used to replace or patch a resource. | *[YAMLOptions](#yamloptions) | false |
|
||||
| yaml | YAML options, if using raw YAML these are names that map to overlays/`{name}` files that will be used to replace or patch a resource. | *[YAMLOptions](#yamloptions) | false |
|
||||
| diff | Diff can be used to ignore the modified state of objects which are amended at runtime. | *[DiffOptions](#diffoptions) | false |
|
||||
| keepResources | KeepResources can be used to keep the deployed resources when removing the bundle | bool | false |
|
||||
| ignore | IgnoreOptions can be used to ignore fields when monitoring the bundle. | [IgnoreOptions](#ignoreoptions) | false |
|
||||
|
|
@ -527,7 +527,7 @@ Define helm values that can come from configmap, secret or external. Credit: htt
|
|||
|
||||
#### YAMLOptions
|
||||
|
||||
YAMLOptions, if using raw YAML these are names that map to overlays/{name} files that will be used to replace or patch a resource.
|
||||
YAMLOptions, if using raw YAML these are names that map to overlays/`{name}` files that will be used to replace or patch a resource.
|
||||
|
||||
| Field | Description | Scheme | Required |
|
||||
| ----- | ----------- | ------ | -------- |
|
||||
|
|
|
|||
Loading…
Reference in New Issue