Skip to content

Commit 1b57b09

Browse files
jaypoulzjaypoulz
committed
Doc update
1 parent dc13b20 commit 1b57b09

File tree

6 files changed

+1110
-2
lines changed

6 files changed

+1110
-2
lines changed

‎etcd/tnf/v1alpha1/doc.go‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
// +k8s:deepcopy-gen=package,register
22
// +k8s:defaulter-gen=TypeMeta
33
// +k8s:openapi-gen=true
4+
// +openshift:featuregated-schema-gen=true
45

6+
// +kubebuilder:validation:Optional
57
// +groupName=tnf.etcd.openshift.io
68
package v1alpha1

‎etcd/tnf/v1alpha1/types_pacemakerstatus.go‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
//go:build !ignore_autogenerated
2-
31
package v1alpha1
42

53
import (

‎etcd/tnf/v1alpha1/zz_generated.crd-manifests/0000_25_etcd_01_pacemakerstatuses-CustomNoUpgrade.crd.yaml‎

Lines changed: 277 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,283 @@ spec:
1717
scope: Cluster
1818
versions:
1919
- name: v1alpha1
20+
schema:
21+
openAPIV3Schema:
22+
description: |-
23+
# PacemakerStatus represents the current state of the Pacemaker cluster as reported by the pcs status command
24+
25+
This resource provides a view into the health and status of a Pacemaker-managed cluster in dual-replica (two-node)
26+
deployments. The status is periodically collected by a privileged controller and made available for monitoring
27+
and health checking purposes.
28+
29+
Compatibility level 4: No compatibility is provided, the API can change at any point for any reason. These capabilities should not be used by applications needing long term support.
30+
properties:
31+
apiVersion:
32+
description: |-
33+
APIVersion defines the versioned schema of this representation of an object.
34+
Servers should convert recognized schemas to the latest internal value, and
35+
may reject unrecognized values.
36+
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
37+
type: string
38+
kind:
39+
description: |-
40+
Kind is a string value representing the REST resource this object represents.
41+
Servers may infer this from the endpoint the client submits requests to.
42+
Cannot be updated.
43+
In CamelCase.
44+
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
45+
type: string
46+
metadata:
47+
type: object
48+
status:
49+
description: status contains the actual pacemaker cluster status information
50+
collected from the cluster.
51+
properties:
52+
collectionError:
53+
description: collectionError contains any error encountered while
54+
collecting status
55+
maxLength: 2048
56+
minLength: 1
57+
type: string
58+
fencingHistory:
59+
description: fencingHistory provides recent fencing events
60+
items:
61+
description: FencingEvent represents a single fencing event from
62+
fence history
63+
properties:
64+
action:
65+
description: action is the fencing action performed (e.g., "reboot",
66+
"off", "on")
67+
maxLength: 16
68+
minLength: 1
69+
type: string
70+
completed:
71+
description: completed is the timestamp when the fencing event
72+
was completed
73+
format: date-time
74+
type: string
75+
status:
76+
description: status is the status of the fencing operation (e.g.,
77+
"success", "failed")
78+
maxLength: 16
79+
minLength: 1
80+
type: string
81+
target:
82+
description: target is the node that was fenced
83+
maxLength: 256
84+
minLength: 1
85+
type: string
86+
required:
87+
- action
88+
- completed
89+
- status
90+
- target
91+
type: object
92+
maxItems: 16
93+
minItems: 1
94+
type: array
95+
x-kubernetes-list-type: atomic
96+
lastUpdated:
97+
description: lastUpdated is the timestamp when this status was last
98+
updated
99+
format: date-time
100+
type: string
101+
nodeHistory:
102+
description: nodeHistory provides recent operation history for troubleshooting
103+
items:
104+
description: NodeHistoryEntry represents a single operation history
105+
entry from node_history
106+
properties:
107+
lastRCChange:
108+
description: lastRCChange is the timestamp when the RC last
109+
changed
110+
format: date-time
111+
type: string
112+
node:
113+
description: node is the node where the operation occurred
114+
maxLength: 256
115+
minLength: 1
116+
type: string
117+
operation:
118+
description: operation is the operation that was performed (e.g.,
119+
"monitor", "start", "stop")
120+
maxLength: 16
121+
minLength: 1
122+
type: string
123+
rc:
124+
description: rc is the return code from the operation
125+
format: int32
126+
type: integer
127+
rcText:
128+
description: rcText is the human-readable return code text (e.g.,
129+
"ok", "error", "not running")
130+
maxLength: 16
131+
minLength: 1
132+
type: string
133+
resource:
134+
description: resource is the resource that was operated on
135+
maxLength: 256
136+
minLength: 1
137+
type: string
138+
required:
139+
- lastRCChange
140+
- node
141+
- operation
142+
- rc
143+
- rcText
144+
- resource
145+
type: object
146+
maxItems: 16
147+
minItems: 1
148+
type: array
149+
x-kubernetes-list-type: atomic
150+
nodes:
151+
description: nodes provides detailed information about each node in
152+
the cluster
153+
items:
154+
description: NodeStatus represents the status of a single node in
155+
the Pacemaker cluster
156+
properties:
157+
mode:
158+
description: mode indicates if the node is in active or standby
159+
mode
160+
enum:
161+
- Active
162+
- Standby
163+
maxLength: 16
164+
minLength: 6
165+
type: string
166+
name:
167+
description: name is the name of the node
168+
maxLength: 256
169+
minLength: 1
170+
type: string
171+
onlineStatus:
172+
description: onlineStatus indicates if the node is online or
173+
offline
174+
enum:
175+
- Online
176+
- Offline
177+
maxLength: 16
178+
minLength: 6
179+
type: string
180+
required:
181+
- name
182+
- onlineStatus
183+
type: object
184+
maxItems: 2
185+
minItems: 2
186+
type: array
187+
x-kubernetes-list-type: atomic
188+
rawXML:
189+
description: |-
190+
rawXML contains the raw XML output from pcs status xml command.
191+
Kept for debugging purposes only; healthcheck should not need to parse this.
192+
maxLength: 262144
193+
minLength: 1
194+
type: string
195+
resources:
196+
description: resources provides detailed information about each resource
197+
in the cluster
198+
items:
199+
description: ResourceStatus represents the status of a single resource
200+
in the Pacemaker cluster
201+
properties:
202+
activeStatus:
203+
description: activeStatus indicates if the resource is active
204+
or inactive
205+
enum:
206+
- Active
207+
- Inactive
208+
maxLength: 16
209+
minLength: 6
210+
type: string
211+
name:
212+
description: name is the name of the resource
213+
maxLength: 256
214+
minLength: 1
215+
type: string
216+
node:
217+
description: node is the node where the resource is running
218+
maxLength: 256
219+
minLength: 1
220+
type: string
221+
resourceAgent:
222+
description: resourceAgent is the resource agent type (e.g.,
223+
"ocf:heartbeat:IPaddr2", "systemd:kubelet")
224+
maxLength: 256
225+
minLength: 1
226+
type: string
227+
role:
228+
description: role is the current role of the resource (e.g.,
229+
"Started", "Stopped")
230+
maxLength: 16
231+
minLength: 1
232+
type: string
233+
required:
234+
- activeStatus
235+
- name
236+
- node
237+
- resourceAgent
238+
- role
239+
type: object
240+
maxItems: 16
241+
minItems: 1
242+
type: array
243+
x-kubernetes-list-type: atomic
244+
summary:
245+
description: summary provides high-level counts and flags for the
246+
cluster state
247+
properties:
248+
nodesOnline:
249+
description: nodesOnline is the count of online nodes
250+
format: int32
251+
maximum: 2
252+
minimum: 0
253+
type: integer
254+
nodesTotal:
255+
description: nodesTotal is the total count of configured nodes
256+
format: int32
257+
maximum: 2
258+
minimum: 0
259+
type: integer
260+
pacemakerdState:
261+
description: pacemakerdState indicates if pacemaker is running
262+
maxLength: 16
263+
minLength: 1
264+
type: string
265+
quorumStatus:
266+
description: quorumStatus indicates if the cluster has quorum
267+
enum:
268+
- Quorate
269+
- NoQuorum
270+
maxLength: 16
271+
minLength: 7
272+
type: string
273+
resourcesStarted:
274+
description: resourcesStarted is the count of started resources
275+
format: int32
276+
maximum: 16
277+
minimum: 0
278+
type: integer
279+
resourcesTotal:
280+
description: resourcesTotal is the total count of configured resources
281+
format: int32
282+
maximum: 16
283+
minimum: 0
284+
type: integer
285+
required:
286+
- nodesOnline
287+
- nodesTotal
288+
- pacemakerdState
289+
- quorumStatus
290+
- resourcesStarted
291+
- resourcesTotal
292+
type: object
293+
type: object
294+
required:
295+
- metadata
296+
type: object
20297
served: true
21298
storage: true
22299
subresources:

0 commit comments

Comments
 (0)