rancher
/
fleet-docs
mirror of https://github.com/rancher/fleet-docs.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #62 from raulcabello/ignore-options 

Add documention for ignore conditions
This commit is contained in:
Mario Manno 2023-05-15 16:46:52 +02:00 committed by GitHub
parent a4c6e42ef1 91aeb9cd9f
commit 91775de8e7
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 26 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
docs/ref-crds.md
View File

@ -67,6 +67,7 @@
* [ClusterRegistrationTokenStatus](#clusterregistrationtokenstatus)
* [ClusterSpec](#clusterspec)
* [ClusterStatus](#clusterstatus)
* [IgnoreOptions](#ignoreoptions)
#### GitRepo
@ -360,15 +361,16 @@
| Field | Description | Scheme | Required |
| ----- | ----------- | ------ | -------- |
| BundleDeploymentOptions | | [BundleDeploymentOptions](#bundledeploymentoptions) | false |
| paused | Paused if set to true, will stop any BundleDeployments from being updated. It will be marked as out of sync. | bool | false |
| rolloutStrategy | RolloutStrategy controls the rollout of bundles, by defining partitions, canaries and percentages for cluster availability. | *[RolloutStrategy](#rolloutstrategy) | false |
| resources | Resources contain the actual resources from the git repo which will be deployed. | [][BundleResource](#bundleresource) | false |
| targets | Targets refer to the clusters which will be deployed to. | [][BundleTarget](#bundletarget) | false |
| targetRestrictions | TargetRestrictions restrict which clusters the bundle will be deployed to. | [][BundleTargetRestriction](#bundletargetrestriction) | false |
| dependsOn | DependsOn refers to the bundles which must be ready before this bundle can be deployed. | [][BundleRef](#bundleref) | false |
| Field | Description | Scheme | Required |
|-------------------------|-----------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------| -------- |
| BundleDeploymentOptions | | [BundleDeploymentOptions](#bundledeploymentoptions) | false |
| paused | Paused if set to true, will stop any BundleDeployments from being updated. It will be marked as out of sync. | bool | false |
| rolloutStrategy | RolloutStrategy controls the rollout of bundles, by defining partitions, canaries and percentages for cluster availability. | *[RolloutStrategy](#rolloutstrategy) | false |
| resources | Resources contain the actual resources from the git repo which will be deployed. | [][BundleResource](#bundleresource) | false |
| targets | Targets refer to the clusters which will be deployed to. | [][BundleTarget](#bundletarget) | false |
| targetRestrictions | TargetRestrictions restrict which clusters the bundle will be deployed to. | [][BundleTargetRestriction](#bundletargetrestriction) | false |
| dependsOn | DependsOn refers to the bundles which must be ready before this bundle can be deployed. | [][BundleRef](#bundleref) | false |
| ignore | Ignore refers to the fields that will not be considered when monitoring the status. | [IgnoreOptions](#ignoreoptions) | false |
[Back to Custom Resources](#custom-resources)
@ -776,6 +778,12 @@ SemVerPolicy specifies a semantic version policy.
[Back to Custom Resources](#custom-resources)
#### IgnoreOptions
| Field | Description | Scheme | Required |
|--------------|--------------------------| ------ |----------|
| conditions | conditions to be ignored | []map[string]string | false |
#### Cluster

9
docs/ref-fleet-yaml.md
View File

@ -193,4 +193,13 @@ dependsOn:
- selector:
matchLabels:
app: weak-monkey
# Ignore fields when monitoring a Bundle. This can be used when Fleet thinks some conditions in Custom Resources
# makes the Bundle to be in an error state when it shouldn't.
ignore:
# Conditions to be ignored
conditions:
# In this example a condition will be ignored if it contains {"type": "Active", "status", "False"}
- type: Active
status: "False"
```