From e573c813f710b8dc007230510f78f3f60614f467 Mon Sep 17 00:00:00 2001 From: Noa Amran Date: Tue, 3 Dec 2019 10:50:25 -0800 Subject: [PATCH] Changing ErrorMessage and ErrorReason to FailureMessage and FailureReason in docs --- docs/book/src/architecture/controllers/cluster.md | 6 +++--- docs/book/src/architecture/controllers/machine.md | 12 ++++++------ 2 files changed, 9 insertions(+), 9 deletions(-) diff --git a/docs/book/src/architecture/controllers/cluster.md b/docs/book/src/architecture/controllers/cluster.md index 528c43f90d45..5506241df060 100644 --- a/docs/book/src/architecture/controllers/cluster.md +++ b/docs/book/src/architecture/controllers/cluster.md @@ -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 diff --git a/docs/book/src/architecture/controllers/machine.md b/docs/book/src/architecture/controllers/machine.md index 6953307f7613..486f6ac30c01 100644 --- a/docs/book/src/architecture/controllers/machine.md +++ b/docs/book/src/architecture/controllers/machine.md @@ -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. +* `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 status: ready: true bootstrapData: "kubeadm init" @@ -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