Skip to content

Commit e2765a0

Browse files
cristian-pariscristian-paris
committed
Add unlisted pages
1 parent f046d5f commit e2765a0

11 files changed

Lines changed: 261 additions & 0 deletions

File tree

‎docs/cloud_operations/kubernetes/resources/condition.md‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
---
2+
title: Condition
3+
description: ''
4+
unlisted: true
5+
---
6+
7+
# [Condition](https://kubernetes.io/docs/reference/kubernetes-api/common-definitions/object-meta/)
8+
9+
Volume represents a named volume in a pod that may be accessed by any container in the Pod.
10+
11+
- name: `string` - required
12+
- persistentVolumeClaim:
13+
- claimName: `string` - required
14+
- readOnly: `boolean`
15+
- configMap:
16+
- name: `string`
17+
- secret:
18+
- secretName: `string`

‎docs/cloud_operations/kubernetes/resources/pod/_category_.json‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
{
2+
"label": "Pods",
3+
"position": 2,
4+
"link": {
5+
"type": "generated-index",
6+
"title": "Pods"
7+
},
8+
"customProps": {
9+
"unlisted": true
10+
}
11+
}

‎docs/cloud_operations/kubernetes/resources/pod/container.md‎

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
---
2+
title: Container
3+
unlisted: true
4+
description: ''
5+
---
6+
7+
# [Container](https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#Container)
8+
9+
- name: `string` - required
10+
- image: `string`
11+
- imagePullPolicy: `"Always" | "Never" | "IfNotPresent"`; Default: `"Always"` if :latest tag is specified, or "IfNotPresent" otherwise. (Can't be updated)
12+
- command: `Array<string>` (entrypoint)
13+
- args: `Array<string>` (entrypoint)
14+
- workingDir: `string` (entrypoint)
15+
- ports: `Array`
16+
- containerPort: `int32` - required (port to expose on the Pod's IP address)
17+
- hostIP: `string` (host IP to bind the external port to)
18+
- hostPort: `int32` (port to expose on the host - most containers don't need this)
19+
- name: `string`
20+
- protocol: `"UDP" | "TCP" | "SCTP"`; Default: `"TCP"`
21+
- env: `Array`
22+
- name: `string` - required
23+
- value: `string`
24+
- valueFrom:
25+
- configMapKeyRef:
26+
- key: `string` - required
27+
- name: `string`
28+
- optional: `boolean`
29+
- fieldRef:
30+
- fieldPath: `metadata.name | metadata.namespace | metadata.labels['\<KEY>'] | metadata.annotations['\<KEY>'] | spec.nodeName | spec.serviceAccountName | status.hostIP | status.podIP | status.podIPs` - required - `string`
31+
- apiVersion: `string` - Default: `"v1"`
32+
- envFrom: `Array`
33+
- configMapRef:
34+
- name: `string`
35+
- optional: `boolean`
36+
- prefix: `string`
37+
- volumeMounts: `Array`
38+
- mountPath: `string` - required
39+
- name: `string` - required
40+
- mountPropagation: `string`
41+
- readOnly: `boolean`
42+
- subPath: `string`
43+
- resources: `Array`
44+
- claims: `Array`
45+
- name: `string` - required
46+
- limits: `map<string, `[`Quantity`](https://kubernetes.io/docs/reference/kubernetes-api/common-definitions/quantity/#Quantity)`>`
47+
- requests: `map<string, `[`Quantity`](https://kubernetes.io/docs/reference/kubernetes-api/common-definitions/quantity/#Quantity)`>`
48+
- livenessProbe: [`Probe`](./probe.md)
49+
- readinessProbe: [`Probe`](./probe.md)

‎docs/cloud_operations/kubernetes/resources/pod/pod-spec.md‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
---
2+
title: Pod Spec
3+
description: ''
4+
unlisted: true
5+
---
6+
7+
# Pod Spec
8+
9+
Here's the most important attributes:
10+
11+
1. containers - [`Array<Container>`](./container.md)
12+
1. volumes - [`Array<Volume>`](./volume.md)

‎docs/cloud_operations/kubernetes/resources/pod/pod-status.md‎

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
---
2+
title: PodStatus
3+
description: ''
4+
unlisted: true
5+
---
6+
7+
# [PodStatus](https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#PodStatus)
8+
9+
The PodStatus represents the information about the status that a Pod is in. Status may TRAIL the actual state of a system, especially if the node that hosts the pod cannot contact the control plane.
10+
11+
Here, we remind the most important:
12+
13+
- phase:
14+
- type: `string` - `"Pending" | "Running" | "Succeeded" | "Failed" | "Unknown"`
15+
- description: summary of the pod lifecycle phase:
16+
- `Pending`: pod has been accepted by kubernetes, but one or more containers have not been started
17+
- `Running`: pod has been placed on a node, all containers have been created and at least one container is running, starting or restarting
18+
- `Succeeded`: all containers in the pod have been terminated successfully and will not be restarted
19+
:::info
20+
21+
While our main focus is on applications (well, containers and pods) that run indefinitely, there can be pods that run once
22+
23+
:::
24+
- `Failed`: all containers in a pod have terminated, and at least one container terminated in a failure
25+
:::warning
26+
27+
The `Failed` status appears, most of the time, when a pod has been restarted too frequently and has failed too frequently, as well
28+
29+
:::
30+
- `Unknown`: the state of the pod could not be obtained. This usually happens because there is trouble communicated with the node where the pod should be running
31+
32+
- conditions:
33+
- type: [`Array<PodCondition>`](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.27/)
34+
- description: list of current observed conditions of the pod:
35+
- `Initialized`: all init containers have started successfully
36+
- `Ready`: the pod is able to serve requests and all containers are ready
37+
- `ContainersReady`: all containers in the pod are ready
38+
- `PodScheduled`: the pod has been scheduled to a node
39+
40+
- hostIP:
41+
- type: `string`
42+
- description: the IP address of the node where the pod is running
43+
44+
- podIP:
45+
- type: `string`
46+
- description: the IP address assigned to the pod
47+
48+
- startTime:
49+
- type: `string (timestamp)`
50+
- description: the time when the pod was acknowledged by the Kubernetes system
51+
52+
- containerStatuses:
53+
- type: [`Array<ContainerStatus>`](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.27/)
54+
- description: detailed information about the status of each container in the pod, including:
55+
- `name`: the name of the container
56+
- `state`: the current state of the container (`waiting`, `running`, or `terminated`)
57+
- `lastState`: details about the last terminated state of the container, if applicable
58+
- `ready`: a boolean indicating if the container is ready to serve requests
59+
- `restartCount`: the number of times the container has been restarted
60+
61+
- message:
62+
- type: `string`
63+
- description: a human-readable message indicating details about why the pod is in its current condition
64+
65+
- reason:
66+
- type: `string`
67+
- description: a brief CamelCase message indicating why the pod is in its current state

‎docs/cloud_operations/kubernetes/resources/pod/probe.md‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
---
2+
title: Probe
3+
description: ''
4+
unlisted: true
5+
---
6+
7+
# [Probe](ttps://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#Probe)
8+
9+
Probes are used to describe health checks to be performed against a container to determine whether it is alive or ready to receive traffic.
10+
11+
- exec:
12+
- command: `Array<string>`
13+
- httpGet:
14+
- port: `integer | string` - required
15+
- host: `string` - defaults to Pod IP
16+
- path: `string`
17+
- scheme: `string` - defaults to 'HTTP'
18+
- initialDelaySeconds: `int32`

‎docs/cloud_operations/kubernetes/resources/pod/volume.md‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
---
2+
title: Volume
3+
description: ''
4+
unlisted: true
5+
---
6+
7+
# [Volume](https://kubernetes.io/docs/reference/kubernetes-api/common-definitions/object-meta/)
8+
9+
Volume represents a named volume in a pod that may be accessed by any container in the Pod.
10+
11+
- name: `string` - required
12+
- persistentVolumeClaim:
13+
- claimName: `string` - required
14+
- readOnly: `boolean`
15+
- configMap:
16+
- name: `string`
17+
- secret:
18+
- secretName: `string`

‎docs/cloud_operations/kubernetes/resources/service/_category_.json‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
{
2+
"label": "Services",
3+
"position": 4,
4+
"link": {
5+
"type": "generated-index",
6+
"title": "Services"
7+
},
8+
"customProps": {
9+
"unlisted": true
10+
}
11+
}

‎docs/cloud_operations/kubernetes/resources/service/service-port.md‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
---
2+
title: Service Port
3+
description: ""
4+
unlisted: true
5+
---
6+
7+
# [Service Port](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.30/#serviceport-v1-core)
8+
9+
Here's the most important attributes:
10+
11+
1. name - `string`
12+
- The name of this port within the service, must be a `DNS_LABEL`. All ports within a `ServiceSpec` must have unique names.
13+
- Optional if only one `ServicePort` is defined.
14+
15+
1. nodePort - `integer`
16+
- The port on each node on which this service is exposed when `type` is `NodePort` or `LoadBalancer`. Usually assigned by the system.
17+
- If specified, the value must be in-range and not in use, otherwise the operation will fail.
18+
- If not specified, a port will be allocated if required.
19+
- This field is cleared when updating a Service to no longer need it (e.g., changing `type` from `NodePort` to `ClusterIP`).
20+
21+
1. port - `integer`
22+
- The port that will be exposed by this service.
23+
24+
1. targetPort - `integer | string`
25+
- The port number or name to access on the pods targeted by the service. Number must be in the range 1 to 65535.
26+
- Name must be an `IANA_SVC_NAME`. If specified as a string, it will be looked up as a named port in the target Pod's container ports.
27+
- If not specified, the value of the `port` field is used.
28+
- This field is ignored for services with `clusterIP=None`, and should be omitted or set equal to the `port` field.

‎docs/cloud_operations/kubernetes/resources/service/service-spec.md‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
---
2+
title: Service Spec
3+
description: ""
4+
unlisted: true
5+
---
6+
7+
# [Service Spec](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.30/#servicespec-v1-core)
8+
9+
Here's the most important attributes:
10+
11+
1. ports - [`Array<ServicePort>`](./service-port.md)
12+
1. selector - `Object`
13+
- Route service traffic to pods with label keys and values matching this selector
14+
1. type - [`"ExternalName" | "ClusterIP" | "NodePort" | "LoadBalancer"` - `string`]
15+
- determines how the Service is exposed
16+
- defaults to `ClusterIP` - which allocates a cluster-internal IP address for load-balancing to endpoints
17+
- endpoints are determined by the selector

0 commit comments

Comments
 (0)