Skip to content

Commit 0a9215d

Browse files
rockb1017rockb1017
authored
add description for useful objects (#62)
1 parent 74eac65 commit 0a9215d

12 files changed

+227
-0
lines changed

‎objects/daemon_sets.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# Kubernetes Daemon_Sets Object
2+
### SourceType: kube:object:daemon_sets
3+
4+
All definitions can be found at https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.20/#daemonset-v1-apps
5+
6+
Field | Description | Example
7+
----- | ----------- | -------
8+
metadata.name | Daemon Set name | sck-splunk-kubernetes-metrics
9+
spec.template.spec.containers{}.image | Docker image name | docker.io/splunk/k8s-metrics:1.1.4
10+
spec.template.spec.containers{}.name | Name of the container | splunk-fluentd-k8s-metrics
11+
spec.template.spec.containers{}.resources.limits.cpu | maximum amount of compute resources allowed | 200m
12+
spec.template.spec.containers{}.resources.limits.memory | maximum amount of compute resources allowed | 300Mi
13+
spec.template.spec.containers{}.resources.requests.cpu | minimum amount of compute resources required | 200m
14+
spec.template.spec.containers{}.resources.requests.memory | minimum amount of compute resources required |300Mi
15+
spec.template.spec.containers{}.volumeMounts{}.mountPath | Path within the container at which the volume should be mounted | /fluentd/etc
16+
spec.template.spec.containers{}.volumeMounts{}.name | This must match the Name of a Volume | conf-configmap
17+
spec.template.spec.containers{}.volumeMounts{}.readOnly | Mounted read-only if true, read-write otherwise | TRUE
18+
spec.template.spec.serviceAccountName | name of the ServiceAccount to use to run this pod | splunk-kubernetes-metrics
19+
status.currentNumberScheduled | number of nodes that are running at least 1 daemon pod and are supposed to run the daemon pod | 1
20+
status.desiredNumberScheduled | number of nodes that should be running the daemon pod | 1
21+
status.numberAvailable | number of nodes that should be running the daemon pod and have one or more of the daemon pod running and available | 1
22+
status.numberReady | number of nodes that should be running the daemon pod and have one or more of the daemon pod running and ready | 1

‎objects/deployments.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# Kubernetes Deployments Object
2+
### SourceType: kube:object:deployments
3+
4+
All definitions can be found at https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.20/#deployment-v1-apps
5+
6+
Field | Description | Example
7+
----- | ----------- | -------
8+
metadata.name | Deployment name | cartservice
9+
spec.replicas | Number of desired pods | 1
10+
spec.strategy.type | Type of deployment | RollingUpdate
11+
spec.template.spec.containers{}.image | Docker image name | gcr.io/google-samples/microservices-demo/cartservice:v0.2.2
12+
spec.template.spec.containers{}.name | Name of the container | server
13+
spec.template.spec.containers{}.livenessProbe.* | Periodic probe of container liveness
14+
spec.template.spec.containers{}.ports{}.containerPort | Number of port to expose on the pod's IP address | 7070
15+
spec.template.spec.containers{}.ports{}.protocol | TCP Protocol for port | TCP
16+
spec.template.spec.containers{}.readinessProbe.* | Periodic probe of container service readiness
17+
spec.template.spec.containers{}.resources.limits.cpu | maximum amount of compute resources allowed | 200m
18+
spec.template.spec.containers{}.resources.limits.memory | maximum amount of compute resources allowed | 300Mi
19+
spec.template.spec.containers{}.resources.requests.cpu | minimum amount of compute resources required | 200m
20+
spec.template.spec.containers{}.resources.requests.memory | minimum amount of compute resources required |300Mi
21+
spec.template.spec.containers{}.volumeMounts{}.mountPath | Path within the container at which the volume should be mounted | /fluentd/etc
22+
spec.template.spec.containers{}.volumeMounts{}.name | This must match the Name of a Volume | conf-configmap
23+
spec.template.spec.containers{}.volumeMounts{}.readOnly | Mounted read-only if true, read-write otherwise | TRUE
24+
spec.template.spec.serviceAccountName | name of the ServiceAccount to use to run this pod | default
25+
status.availableReplicas | number of available pods | 1
26+
status.conditions{}.message ReplicaSet | A human readable message indicating details about the transition | "cartservice-67b89ffc69" has successfully progressed
27+
status.readyReplicas | number of ready pods targeted by this deployment | 1

‎objects/namespaces.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# Kubernetes Namespaces Object
2+
### SourceType: kube:object:namespaces
3+
4+
All definitions can be found at https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.20/#namespace-v1-core
5+
6+
Field | Description | Example
7+
----- | ----------- | -------
8+
metadata.name | Namespace name | splunk
9+
metadata.creationTimestamp | Time the namespace was created | 2020-06-04T14:36:29Z
10+
status.phase | current lifecycle phase of the namespace | Active

‎objects/nodes.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# Kubernetes Nodes Object
2+
### SourceType: kube:object:nodes
3+
4+
All definitions can be found at https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.20/#node-v1-core
5+
6+
Field | Description | Example
7+
----- | ----------- | -------
8+
metadata.name | Node Name | ip-192-168-16-232.ec2.internal
9+
status.addresses{}.address | List of addresses for the node | 192.168.16.232
10+
status.addresses{}.type | Address types for the node that align to the addresses | InternalIP
11+
status.allocatable.* | Resources of a node that are available for scheduling | 1930m, 2886616Ki
12+
status.capacity.* | Total resources of a node | 2, 20959212Ki
13+
status.conditions{}.message | Human readable message indicating details about last transition | kubelet has sufficient memory available
14+
status.nodeInfo.architecture | Architecture reported by the node | amd64
15+
status.nodeInfo.containerRuntimeVersion | ContainerRuntime Version reported by the node | docker://18.9.9
16+
status.nodeInfo.kernelVersion | Kernel Version reported by the node | 4.14.177-139.253.amzn2.x86_64
17+
status.nodeInfo.kubeProxyVersion | KubeProxy Version reported by the node | v1.15.11-eks-af3caf
18+
status.nodeInfo.kubeletVersion | Kubelet Version reported by the node | v1.15.11-eks-af3caf
19+
status.nodeInfo.operatingSystem | The Operating System reported by the node | linux
20+
status.nodeInfo.osImage | OS Image reported by the node | Amazon Linux 2
21+

‎objects/persistent_volume_claims.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# Kubernetes Persistent_Volume_Claims Object
2+
### SourceType: kube:object:persistent_volume_claims
3+
4+
All definitions can be found at https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.20/#persistentvolumeclaim-v1-core
5+
6+
Field | Description | Example
7+
----- | ----------- | -------
8+
metadata.name | Persistent Volume Claim Name | pvc-var-splunk-dev-standalone-0
9+
spec.resources.requests.storage | Minimum amount of compute resources required | 100Gi
10+
spec.storageClassName | Name of the StorageClass required by the claim | microk8s-hostpath
11+
spec.volumeName | Binding reference to the PersistentVolume backing this claim | pvc-4073c97f-0b85-418c-9b64-ed5154875ec8
12+
status.capacity.storage | Actual resources of the underlying volume | 100Gi
13+
status.phase | Indicates if a volume is available, bound to a claim, or released by a claim | Bound

‎objects/persistent_volumes.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# Kubernetes Persistent_Volumes Object
2+
### SourceType: kube:object:persistent_volumes
3+
4+
All definitions can be found at https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.20/#persistentvolume-v1-core
5+
6+
Field | Description | Example
7+
----- | ----------- | -------
8+
metadata.name | Persistent Volume Name | pvc-ff21aff0-b715-4d6a-acec-f855ce2c7535
9+
spec.capacity.storage | persistent volume's resources and capacity | 50Gi
10+
spec.*type* | different types of persistent volumes that are defined
11+
spec.persistentVolumeReclaimPolicy | What happens to a persistent volume when released from its claim | Delete
12+
spec.storageClassName | Name of StorageClass to which this persistent volume belongs | microk8s-hostpath
13+
status.phase | Indicates if a volume is available, bound to a claim, or released by a claim | Bound

‎objects/pods.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# Kubernetes Pods Object
2+
### SourceType: kube:object:pods
3+
4+
All definitions can be found at https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.20/#pod-v1-core
5+
6+
Field | Description | Example
7+
----- | ----------- | -------
8+
metadata.name | Pod Name | adminfrontend-c8b48c574-dsl4q
9+
spec.containers{}.image | Docker image name | docker.io/splunk/k8s-metrics:1.1.3
10+
spec.containers{}.name | Container Name | splunk-fluentd-k8s-metrics
11+
spec.containers{}.ports{}.containerPort | Number of port to expose on the pod's IP address | 443
12+
spec.containers{}.volumeMounts{}.mountPath | Path within the container at which the volume should be mounted | /var/run/secrets/kubernetes.io/serviceaccount
13+
spec.containers{}.volumeMounts{}.name | Volume's name that has been mounted | default-token-njbcn
14+
spec.volumes{}.hostPath.path | Path of the directory on the host | /var/lib/docker/overlay2
15+
spec.volumes{}.name | Volume's name | default-token-njbcn
16+
spec.containers{}.livenessProbe.* | Information on periodic probe of container liveness
17+
spec.containers{}.readinessProbe.* | Information on periodic probe of container readiness
18+
spec.containers{}.securityContext.privileged | Run container in privileged mode | TRUE
19+
spec.containers{}.securityContext.allowPrivilegeEscalation | Whether a process can gain more privileges than its parent process | TRUE
20+
spec.securityContext.runAsGroup | The GID to run the entrypoint of the container process | 4188
21+
spec.securityContext.runAsUser | The UID to run the entrypoint of the container process | 4188
22+
spec.securityContext.runAsNonRoot | Indicates that the container must run as a non-root user | 0
23+
spec.serviceAccountName | ServiceAccount to use to run this pod | default
24+
status.containerStatuses{}.image | The image the container is running | k8tan/admin_frontend:latest
25+
status.containerStatuses{}.name | Container name that is running | adminfrontend
26+
status.containerStatuses{}.ready | Specifies whether the container has passed its readiness probe | TRUE
27+
status.containerStatuses{}.restartCount | The number of times the container has been restarted | 1
28+
status.containerStatuses{}.state.running.startedAt | Time at which the container was last (re-)started | 2020-07-28T16:41:29Z
29+
status.hostIP | IP address of the host to which the pod is assigned | 192.168.16.232
30+
status.message | Human readable message indicating details about why the pod is in this condition | Pod The node had condition: [MemoryPressure].
31+
status.phase | High-level summary of where the Pod is in its lifecycle | Running
32+
status.podIP | IP address allocated to the pod | 192.168.25.49
33+
status.reason | Brief CamelCase message indicating details about why the pod is in this state | Evicted
34+

‎objects/replica_sets.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# Kubernetes Replica_Sets Object
2+
### SourceType: kube:object:replica_sets
3+
4+
All definitions can be found at https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.20/#replicaset-v1-apps
5+
6+
Field | Description | Example
7+
----- | ----------- | -------
8+
metadata.name | Replica Set name | cartservice
9+
spec.replicas | Number of desired pods | 3
10+
spec.template.spec.containers{}.image | Docker image name | 602321143452.dkr.ecr.us-east-1.amazonaws.com/eks/coredns:v1.8.0-eksbuild.1
11+
spec.template.spec.containers{}.name | Name of the container | server
12+
spec.template.spec.containers{}.livenessProbe.* | Periodic probe of container liveness
13+
spec.template.spec.containers{}.ports{}.containerPort | Number of port to expose on the pod's IP address | 7070
14+
spec.template.spec.containers{}.ports{}.protocol | TCP Protocol for port | TCP
15+
spec.template.spec.containers{}.readinessProbe.* | Periodic probe of container service readiness
16+
spec.template.spec.containers{}.resources.limits.cpu | maximum amount of compute resources allowed | 200m
17+
spec.template.spec.containers{}.resources.limits.memory | maximum amount of compute resources allowed | 300Mi
18+
spec.template.spec.containers{}.resources.requests.cpu | minimum amount of compute resources required | 200m
19+
spec.template.spec.containers{}.resources.requests.memory | minimum amount of compute resources required |300Mi
20+
spec.template.spec.containers{}.volumeMounts{}.mountPath | Path within the container at which the volume should be mounted | /fluentd/etc
21+
spec.template.spec.containers{}.volumeMounts{}.name | This must match the Name of a Volume | conf-configmap
22+
spec.template.spec.containers{}.volumeMounts{}.readOnly | Mounted read-only if true, read-write otherwise | TRUE
23+
spec.template.spec.serviceAccountName | name of the ServiceAccount to use to run this pod | default
24+
status.availableReplicas | number of available pods | 2
25+
status.readyReplicas | number of ready pods targeted by this deployment | 2
26+
status.replicas | number of non-terminated pods targeted by this deployment | 2

‎objects/resource_quotas.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# Kubernetes Resource_Quotas Object
2+
### SourceType: kube:object:resource_quotas
3+
4+
All definitions can be found at https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.20/#resourcequota-v1-core
5+
6+
Field | Description | Example
7+
----- | ----------- | -------
8+
status.used.pods | Total usage of the resource in the namespace | 2
9+
status.used.services | Total usage of the resource in the namespace | 0

‎objects/service_accounts.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# Kubernetes Service_Accounts Object
2+
### SourceType: kube:object:service_accounts
3+
4+
All definitions can be found at https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.20/#serviceaccount-v1-core
5+
6+
Field | Description | Example
7+
----- | ----------- | -------
8+
metadata.name | Service account name | splunk-operator
9+
metadata.creationTimestamp | Time the account was created | 2020-06-04T14:36:29Z

0 commit comments

Comments
 (0)