Skip to content

Commit 7eb721b

Browse files
authored
Merge pull request #1822 from noamran/docs-error
📖 Renaming ErrorMessage and ErrorReason to FailureMessage and FailureReason in docs
2 parents 91efb1d + e573c81 commit 7eb721b

File tree

2 files changed

+9
-9
lines changed

2 files changed

+9
-9
lines changed

docs/book/src/architecture/controllers/cluster.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -35,13 +35,13 @@ The `status` object **must** have the following fields defined:
3535

3636
The `status` object **may** define several fields that do not affect functionality if missing:
3737

38-
* `errorReason` - is a string that explains why an error has occurred, if possible.
39-
* `errorMessage` - is a string that holds the message contained by the error.
38+
* `failureReason` - is a string that explains why a fatal error has occurred, if possible.
39+
* `failureMessage` - is a string that holds the message contained by the error.
4040

4141
Example:
4242
```yaml
4343
kind: MyProviderCluster
44-
apiVersion: infrastructure.cluster.x-k8s.io/v1alpha2
44+
apiVersion: infrastructure.cluster.x-k8s.io/v1alpha3
4545
spec:
4646
controlPlaneEndpoint:
4747
host: example.com

docs/book/src/architecture/controllers/machine.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -48,14 +48,14 @@ The `status` object **must** have several fields defined:
4848

4949
The `status` object **may** define several fields that do not affect functionality if missing:
5050

51-
* `errorReason` - is a string that explains why an error has occurred, if possible.
52-
* `errorMessage` - is a string that holds the message contained by the error.
51+
* `failureReason` - is a string that explains why a fatal error has occurred, if possible.
52+
* `failureMessage` - is a string that holds the message contained by the error.
5353

5454
Example:
5555

5656
```yaml
5757
kind: MyBootstrapProviderConfig
58-
apiVersion: bootstrap.cluster.x-k8s.io/v1alpha2
58+
apiVersion: bootstrap.cluster.x-k8s.io/v1alpha3
5959
status:
6060
ready: true
6161
bootstrapData: "kubeadm init"
@@ -79,13 +79,13 @@ The `status` object **must** have several fields defined:
7979

8080
The `status` object **may** define several fields that do not affect functionality if missing:
8181

82-
* `errorReason` - is a string that explains why an error has occurred, if possible.
83-
* `errorMessage` - is a string that holds the message contained by the error.
82+
* `failureReason` - is a string that explains why a fatal error has occurred, if possible.
83+
* `failureMessage` - is a string that holds the message contained by the error.
8484

8585
Example:
8686
```yaml
8787
kind: MyMachine
88-
apiVersion: infrastructure.cluster.x-k8s.io/v1alpha2
88+
apiVersion: infrastructure.cluster.x-k8s.io/v1alpha3
8989
status:
9090
ready: true
9191
providerID: cloud:////my-cloud-provider-id

0 commit comments

Comments
 (0)