Skip to content

📖 Renaming ErrorMessage and ErrorReason to FailureMessage and FailureReason in docs #1822

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Dec 5, 2019
Merged

📖 Renaming ErrorMessage and ErrorReason to FailureMessage and FailureReason in docs #1822

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions docs/book/src/architecture/controllers/cluster.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,13 +35,13 @@ The `status` object **must** have the following fields defined:

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

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

Example:
```yaml
kind: MyProviderCluster
apiVersion: infrastructure.cluster.x-k8s.io/v1alpha2
apiVersion: infrastructure.cluster.x-k8s.io/v1alpha3
spec:
controlPlaneEndpoint:
host: example.com
Expand Down
12 changes: 6 additions & 6 deletions docs/book/src/architecture/controllers/machine.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,14 +48,14 @@ The `status` object **must** have several fields defined:

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

* `errorReason` - is a string that explains why an error has occurred, if possible.
* `errorMessage` - is a string that holds the message contained by the error.
* `failureReason` - is a string that explains why a fatal error has occurred, if possible.
Copy link
Contributor Author

@noamran noamran Dec 3, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This section is only relevant after #1800 is merged.

* `failureMessage` - is a string that holds the message contained by the error.

Example:

```yaml
kind: MyBootstrapProviderConfig
apiVersion: bootstrap.cluster.x-k8s.io/v1alpha2
apiVersion: bootstrap.cluster.x-k8s.io/v1alpha3
Copy link
Contributor Author

@noamran noamran Dec 3, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This section is only relevant after #1800 is merged.

status:
ready: true
bootstrapData: "kubeadm init"
Expand All @@ -79,13 +79,13 @@ The `status` object **must** have several fields defined:

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

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

Example:
```yaml
kind: MyMachine
apiVersion: infrastructure.cluster.x-k8s.io/v1alpha2
apiVersion: infrastructure.cluster.x-k8s.io/v1alpha3
status:
ready: true
providerID: cloud:////my-cloud-provider-id
Expand Down