Skip to content

Commit 0c8edd1

Browse files
authored
Merge pull request #64711 from eggfoobar/update-microshift-docs
OSDOCS-5316: Update microshift docs
2 parents 2d4b182 + 2d0ccfc commit 0c8edd1

File tree

95 files changed

+99665
-449
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

95 files changed

+99665
-449
lines changed

_topic_maps/_topic_map_ms.yml

Lines changed: 259 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -88,16 +88,275 @@ Topics:
8888
File: understanding-api-support-tiers
8989
- Name: API compatibility guidelines
9090
File: understanding-compatibility-guidelines
91+
- Name: API index
92+
File: index
93+
- Name: API object reference
94+
Dir: objects
95+
Topics:
96+
- Name: API objects reference
97+
File: index
98+
- Name: Extension APIs
99+
Dir: api_extensions_apis
100+
Topics:
101+
- Name: Extension APIs
102+
File: api-extensions-apis-index
103+
- Name: CustomResourceDefinition [apiextensions.k8s.io/v1]
104+
File: customresourcedefinition-apiextensions-k8s-io-v1
105+
- Name: Registration APIs
106+
Dir: api_registration_apis
107+
Topics:
108+
- Name: Registration APIs
109+
File: api-registration-apis-index
110+
- Name: APIService [apiregistration.k8s.io/v1]
111+
File: apiservice-apiregistration-k8s-io-v1
112+
- Name: Apps APIs
113+
Dir: apps_apis
114+
Topics:
115+
- Name: Apps APIs
116+
File: apps-apis-index
117+
- Name: ControllerRevision [apps/v1]
118+
File: controllerrevision-apps-v1
119+
- Name: DaemonSet [apps/v1]
120+
File: daemonset-apps-v1
121+
- Name: Deployment [apps/v1]
122+
File: deployment-apps-v1
123+
- Name: ReplicaSet [apps/v1]
124+
File: replicaset-apps-v1
125+
- Name: StatefulSet [apps/v1]
126+
File: statefulset-apps-v1
127+
- Name: Authentication APIs
128+
Dir: authentication_apis
129+
Topics:
130+
- Name: Authentication APIs
131+
File: authentication-apis-index
132+
- Name: TokenRequest [authentication.k8s.io/v1]
133+
File: tokenrequest-authentication-k8s-io-v1
134+
- Name: TokenReview [authentication.k8s.io/v1]
135+
File: tokenreview-authentication-k8s-io-v1
136+
- Name: Authorization APIs
137+
Dir: authorization_apis
138+
Topics:
139+
- Name: Authorization APIs
140+
File: authorization-apis-index
141+
- Name: LocalSubjectAccessReview [authorization.k8s.io/v1]
142+
File: localsubjectaccessreview-authorization-k8s-io-v1
143+
- Name: SelfSubjectAccessReview [authorization.k8s.io/v1]
144+
File: selfsubjectaccessreview-authorization-k8s-io-v1
145+
- Name: SelfSubjectRulesReview [authorization.k8s.io/v1]
146+
File: selfsubjectrulesreview-authorization-k8s-io-v1
147+
- Name: SubjectAccessReview [authorization.k8s.io/v1]
148+
File: subjectaccessreview-authorization-k8s-io-v1
149+
- Name: Autoscaling APIs
150+
Dir: autoscaling_apis
151+
Topics:
152+
- Name: Autoscaling APIs
153+
File: autoscaling-apis-index
154+
- Name: HorizontalPodAutoscaler [autoscaling/v2]
155+
File: horizontalpodautoscaler-autoscaling-v2
156+
- Name: Scale [autoscaling/v1]
157+
File: scale-autoscaling-v1
158+
- Name: Batch APIs
159+
Dir: batch_apis
160+
Topics:
161+
- Name: Batch APIs
162+
File: batch-apis-index
163+
- Name: CronJob [batch/v1]
164+
File: cronjob-batch-v1
165+
- Name: Job [batch/v1]
166+
File: job-batch-v1
167+
- Name: Certificates APIs
168+
Dir: certificates_apis
169+
Topics:
170+
- Name: Certificates APIs
171+
File: certificates-apis-index
172+
- Name: CertificateSigningRequest [certificates.k8s.io/v1]
173+
File: certificatesigningrequest-certificates-k8s-io-v1
174+
- Name: Coordination APIs
175+
Dir: coordination_apis
176+
Topics:
177+
- Name: Coordination APIs
178+
File: coordination-apis-index
179+
- Name: Lease [coordination.k8s.io/v1]
180+
File: lease-coordination-k8s-io-v1
181+
- Name: Core APIs
182+
Dir: core_apis
183+
Topics:
184+
- Name: Core APIs
185+
File: core-apis-index
186+
- Name: Binding [v1]
187+
File: binding-v1
188+
- Name: ComponentStatus [v1]
189+
File: componentstatus-v1
190+
- Name: ConfigMap [v1]
191+
File: configmap-v1
192+
- Name: Endpoints [v1]
193+
File: endpoints-v1
194+
- Name: Event [v1]
195+
File: event-v1
196+
- Name: LimitRange [v1]
197+
File: limitrange-v1
198+
- Name: Namespace [v1]
199+
File: namespace-v1
200+
- Name: Node [v1]
201+
File: node-v1
202+
- Name: PersistentVolume [v1]
203+
File: persistentvolume-v1
204+
- Name: PersistentVolumeClaim [v1]
205+
File: persistentvolumeclaim-v1
206+
- Name: Pod [v1]
207+
File: pod-v1
208+
- Name: PodTemplate [v1]
209+
File: podtemplate-v1
210+
- Name: ReplicationController [v1]
211+
File: replicationcontroller-v1
212+
- Name: ResourceQuota [v1]
213+
File: resourcequota-v1
214+
- Name: Secret [v1]
215+
File: secret-v1
216+
- Name: Service [v1]
217+
File: service-v1
218+
- Name: ServiceAccount [v1]
219+
File: serviceaccount-v1
220+
- Name: Discovery APIs
221+
Dir: discovery_apis
222+
Topics:
223+
- Name: Discovery APIs
224+
File: discovery-apis-index
225+
- Name: EndpointSlice [discovery.k8s.io/v1]
226+
File: endpointslice-discovery-k8s-io-v1
227+
- Name: Events APIs
228+
Dir: events_apis
229+
Topics:
230+
- Name: Events APIs
231+
File: events-apis-index
232+
- Name: Event [events.k8s.io/v1]
233+
File: event-events-k8s-io-v1
234+
- Name: Flow Control APIs
235+
Dir: flow_control_apis
236+
Topics:
237+
- Name: Flow Control APIs
238+
File: flow-control-apis-index
239+
- Name: FlowSchema [flowcontrol.apiserver.k8s.io/v1beta3]
240+
File: flowschema-flowcontrol-apiserver-k8s-io-v1beta3
241+
- Name: PriorityLevelConfiguration [flowcontrol.apiserver.k8s.io/v1beta3]
242+
File: prioritylevelconfiguration-flowcontrol-apiserver-k8s-io-v1beta3
243+
- Name: Networking APIs
244+
Dir: networking_apis
245+
Topics:
246+
- Name: Networking APIs
247+
File: networking-apis-index
248+
- Name: Ingress [networking.k8s.io/v1]
249+
File: ingress-networking-k8s-io-v1
250+
- Name: IngressClass [networking.k8s.io/v1]
251+
File: ingressclass-networking-k8s-io-v1
252+
- Name: NetworkPolicy [networking.k8s.io/v1]
253+
File: networkpolicy-networking-k8s-io-v1
254+
- Name: Node APIs
255+
Dir: node_apis
256+
Topics:
257+
- Name: Node APIs
258+
File: node-apis-index
259+
- Name: RuntimeClass [node.k8s.io/v1]
260+
File: runtimeclass-node-k8s-io-v1
261+
- Name: Policy APIs
262+
Dir: policy_apis
263+
Topics:
264+
- Name: Policy APIs
265+
File: policy-apis-index
266+
- Name: Eviction [policy/v1]
267+
File: eviction-policy-v1
268+
- Name: PodDisruptionBudget [policy/v1]
269+
File: poddisruptionbudget-policy-v1
270+
- Name: RBAC APIs
271+
Dir: rbac_apis
272+
Topics:
273+
- Name: RBAC APIs
274+
File: rbac-apis-index
275+
- Name: ClusterRole [rbac.authorization.k8s.io/v1]
276+
File: clusterrole-rbac-authorization-k8s-io-v1
277+
- Name: ClusterRoleBinding [rbac.authorization.k8s.io/v1]
278+
File: clusterrolebinding-rbac-authorization-k8s-io-v1
279+
- Name: Role [rbac.authorization.k8s.io/v1]
280+
File: role-rbac-authorization-k8s-io-v1
281+
- Name: RoleBinding [rbac.authorization.k8s.io/v1]
282+
File: rolebinding-rbac-authorization-k8s-io-v1
91283
- Name: Network APIs
92284
Dir: network_apis
93285
Topics:
286+
- Name: Network APIs
287+
File: network-apis-index
94288
- Name: Route [route.openshift.io/v1]
95289
File: route-route-openshift-io-v1
290+
- Name: Scheduling APIs
291+
Dir: scheduling_apis
292+
Topics:
293+
- Name: Scheduling APIs
294+
File: scheduling-apis-index
295+
- Name: PriorityClass [scheduling.k8s.io/v1]
296+
File: priorityclass-scheduling-k8s-io-v1
96297
- Name: Security APIs
97298
Dir: security_apis
98299
Topics:
300+
- Name: Security APIs
301+
File: security-apis-index
99302
- Name: SecurityContextConstraints [security.openshift.io/v1]
100303
File: securitycontextconstraints-security-openshift-io-v1
304+
- Name: Security-Internal APIs
305+
Dir: security_internal_apis
306+
Topics:
307+
- Name: Security Internal APIs
308+
File: security-internal-apis-index
309+
- Name: RangeAllocation [security.internal.openshift.io/v1]
310+
File: rangeallocation-security-internal-openshift-io-v1
311+
- Name: Snapshot APIs
312+
Dir: snapshot_apis
313+
Topics:
314+
- Name: CSI Snapshot APIs
315+
File: snapshot-apis-index
316+
- Name: VolumeSnapshot [snapshot.storage.k8s.io/v1]
317+
File: volumesnapshot-snapshot-storage-k8s-io-v1
318+
- Name: VolumeSnapshotClass [snapshot.storage.k8s.io/v1]
319+
File: volumesnapshotclass-snapshot-storage-k8s-io-v1
320+
- Name: VolumeSnapshotContent [snapshot.storage.k8s.io/v1]
321+
File: volumesnapshotcontent-snapshot-storage-k8s-io-v1
322+
- Name: Storage APIs
323+
Dir: storage_apis
324+
Topics:
325+
- Name: Storage APIs
326+
File: storage-apis-index
327+
- Name: CSIDriver [storage.k8s.io/v1]
328+
File: csidriver-storage-k8s-io-v1
329+
- Name: CSINode [storage.k8s.io/v1]
330+
File: csinode-storage-k8s-io-v1
331+
- Name: CSIStorageCapacity [storage.k8s.io/v1]
332+
File: csistoragecapacity-storage-k8s-io-v1
333+
- Name: StorageClass [storage.k8s.io/v1]
334+
File: storageclass-storage-k8s-io-v1
335+
- Name: VolumeAttachment [storage.k8s.io/v1]
336+
File: volumeattachment-storage-k8s-io-v1
337+
- Name: Storage Version Migration APIs
338+
Dir: storage_version_migration_apis
339+
Topics:
340+
- Name: Storage Version Migration APIs
341+
File: storage-version-migration-apis-index
342+
- Name: StorageVersionMigration [migration.k8s.io/v1alpha1]
343+
File: storageversionmigration-migration-k8s-io-v1alpha1
344+
- Name: TopoLVM APIs
345+
Dir: topolvm_apis
346+
Topics:
347+
- Name: TopoLVM APIs
348+
File: topolvm-apis-index
349+
- Name: LogicalVolume [topolvm.io/v1]
350+
File: logicalvolume-topolvm-io-v1
351+
- Name: Webhook APIs
352+
Dir: webhook_apis
353+
Topics:
354+
- Name: Webhook APIs
355+
File: webhook-apis-index
356+
- Name: MutatingWebhookConfiguration [admissionregistration.k8s.io/v1]
357+
File: mutatingwebhookconfiguration-admissionregistration-k8s-io-v1
358+
- Name: ValidatingWebhookConfiguration [admissionregistration.k8s.io/v1]
359+
File: validatingwebhookconfiguration-admissionregistration-k8s-io-v1
101360
---
102361
Name: CLI tools
103362
Dir: microshift_cli_ref
Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
// Automatically generated by 'openshift-apidocs-gen'. Do not edit.
2+
:_content-type: ASSEMBLY
3+
[id="api-extensions-apis"]
4+
= API Extensions APIs
5+
:toc: macro
6+
:toc-title:
7+
8+
toc::[]
9+
10+
== CustomResourceDefinition [apiextensions.k8s.io/v1]
11+
12+
Description::
13+
+
14+
--
15+
CustomResourceDefinition represents a resource that should be exposed on the API server. Its name MUST be in the format <.spec.name>.<.spec.group>.
16+
--
17+
18+
Type::
19+
`object`
20+

0 commit comments

Comments
 (0)