Skip to content

Kubernetes

Apply manifests, describe resources, get pods, logs, and scale deployments.

5 modules

ModuleDescription
套用清單透過 kubectl apply 套用 Kubernetes 清單
描述資源詳細描述 Kubernetes 資源
取得 Pods列出命名空間中的 Kubernetes pods
取得 Pod 日誌從 Kubernetes pod 獲取日誌
調整部署將 Kubernetes 部署調整到指定的副本數量

Modules

套用清單

k8s.apply

透過 kubectl apply 套用 Kubernetes 清單

Parameters:

NameTypeRequiredDefaultDescription
manifeststringYes-Kubernetes manifest as YAML string or JSON object
namespacestringNo-Override namespace for the resource (optional)
kubeconfigstringNo-Path to kubeconfig file (uses default if not set)

Output:

FieldTypeDescription
kindstring資源類型(例如 Deployment, Service)
namestring資源名稱
namespacestring資源命名空間
actionstring執行的動作(已建立, 已配置, 未變更)

描述資源

k8s.describe

詳細描述 Kubernetes 資源

Parameters:

NameTypeRequiredDefaultDescription
resource_typestringYes-Kubernetes resource type (e.g. pod, deployment, service)
namestringYes-Name of the resource to describe
namespacestringNodefaultKubernetes namespace (ignored for cluster-scoped resources)
kubeconfigstringNo-Path to kubeconfig file (uses default if not set)

Output:

FieldTypeDescription
resource_typestring被描述的資源類型
namestring資源名稱
namespacestringKubernetes 命名空間
descriptionstring完整的 kubectl describe 輸出文字

取得 Pods

k8s.get_pods

列出命名空間中的 Kubernetes pods

Parameters:

NameTypeRequiredDefaultDescription
namespacestringNodefaultKubernetes namespace to list pods from
label_selectorstringNo-Filter pods by label selector (e.g. app=nginx)
kubeconfigstringNo-Path to kubeconfig file (uses default if not set)

Output:

FieldTypeDescription
podsarray包含狀態資訊的 pods 清單
countnumber找到的 pods 總數

取得 Pod 日誌

k8s.logs

從 Kubernetes pod 獲取日誌

Parameters:

NameTypeRequiredDefaultDescription
podstringYes-Name of the pod to retrieve logs from
namespacestringNodefaultKubernetes namespace
containerstringNo-Specific container name (for multi-container pods)
tailnumberNo100Number of recent log lines to retrieve
previousbooleanNoFalseGet logs from the previous terminated container instance
kubeconfigstringNo-Path to kubeconfig file (uses default if not set)

Output:

FieldTypeDescription
podstringPod 名稱
logsstring日誌輸出文字
linesnumber返回的日誌行數

調整部署

k8s.scale

將 Kubernetes 部署調整到指定的副本數量

Parameters:

NameTypeRequiredDefaultDescription
deploymentstringYes-Name of the deployment to scale
replicasnumberYes-Desired number of replicas
namespacestringNodefaultKubernetes namespace
kubeconfigstringNo-Path to kubeconfig file (uses default if not set)

Output:

FieldTypeDescription
deploymentstring部署名稱
replicasnumber請求的副本數量
namespacestringKubernetes 命名空間
scaledboolean調整操作是否成功

Released under the Apache 2.0 License.