思维导图备注

Kubernetes v1.23 Documentation
首页 白天 夜间 BookChat 小程序 小程序 阅读
  • 书签 我的书签
  • 添加书签 添加书签 移除书签 移除书签

Documentation style overview

 Github  来源:Kubernetes 浏览 234 扫码 分享 2021-12-09 08:27:05
  • Documentation style overview
    • Documentation Content Guide
    • Documentation Style Guide
    • Writing a new topic
    • Page content types
    • Content organization
    • Custom Hugo Shortcodes

    Documentation style overview

    The topics in this section provide guidance on writing style, content formatting and organization, and using Hugo customizations specific to Kubernetes documentation.

    Documentation Content Guide
    Documentation Style Guide
    Writing a new topic
    Page content types
    Content organization
    Custom Hugo Shortcodes
    当前内容版权归 Kubernetes 或其关联方所有，如需对内容或内容相关联开源项目进行关注与资助，请访问 Kubernetes .
    上一篇:
    下一篇:
    • 书签
    • 添加书签 移除书签
    • Kubernetes v1.31 Documentation
    • Kubernetes v1.31 中文文档
    • Kubernetes v1.30 Documentation
    • Kubernetes v1.30 中文文档
    • Kubernetes v1.29 中文文档
    • Kubernetes v1.29 Documentation
    • Kubernetes v1.28 中文文档
    • Kubernetes v1.28 Documentation
    • Kubernetes v1.27 Documentation
    • Kubernetes v1.27 中文文档
    • Kubernetes v1.26 Documentation
    • Kubernetes v1.26 中文文档
    • Kubernetes v1.25 中文文档
    • Kubernetes v1.25 Documentation
    • Kubernetes v1.24 Documentation
    • Kubernetes v1.24 中文文档
    • Kubernetes v1.23 Documentation
    • Kubernetes v1.23 中文文档
    • Kubernetes v1.22 官方文档
    • Kubernetes v1.22 Documentation
    • Kubernetes v1.21 Documentation
    • Kubernetes v1.21 官方文档(全)
    • Kubernetes v1.20 Documentation
    • Kubernetes v1.20 官方文档(全)
    • Kubernetes v1.19 概念手册
    • Kubernetes v1.19 参考指南
    • Kubernetes v1.19 任务手册
    • Kubernetes v1.19 使用教程
    • Kubernetes v1.19 入门教程
    • Kubernetes v1.18 参考指南
    • Kubernetes v1.18 概念手册
    • Kubernetes v1.18 使用教程
    • Kubernetes v1.18 入门教程
    • Kubernetes v1.17 教程
    • Kubernetes v1.17 概念手册
    • Kubernetes v1.17 参考指南
    • Kubernetes v1.17 任务手册
    • Kubernetes v1.17 入门手册
    • Kubernetes v1.16 官方参考指南
    • Kubernetes v1.16 官方中文文档
    • Home
      • Available Documentation Versions
    • Getting started
      • Learning environment
      • Production environment
        • Container runtimes
        • Installing Kubernetes with deployment tools
          • Bootstrapping clusters with kubeadm
            • Installing kubeadm
            • Troubleshooting kubeadm
            • Creating a cluster with kubeadm
            • Customizing components with the kubeadm API
            • Options for Highly Available topology
            • Creating Highly Available clusters with kubeadm
            • Set up a High Availability etcd cluster with kubeadm
            • Configuring each kubelet in your cluster using kubeadm
            • Dual-stack support with kubeadm
          • Installing Kubernetes with kops
          • Installing Kubernetes with Kubespray
        • Turnkey Cloud Solutions
        • Windows in Kubernetes
          • Windows containers in Kubernetes
          • Guide for scheduling Windows containers in Kubernetes
      • Best practices
        • Considerations for large clusters
        • Running in multiple zones
        • Validate node setup
        • Enforcing Pod Security Standards
        • PKI certificates and requirements
    • Concepts
      • Overview
        • What is Kubernetes?
        • Kubernetes Components
        • The Kubernetes API
        • Working with Kubernetes Objects
          • Understanding Kubernetes Objects
          • Kubernetes Object Management
          • Object Names and IDs
          • Namespaces
          • Labels and Selectors
          • Annotations
          • Field Selectors
          • Finalizers
          • Owners and Dependents
          • Recommended Labels
      • Cluster Architecture
        • Nodes
        • Control Plane-Node Communication
        • Controllers
        • Cloud Controller Manager
        • Container Runtime Interface (CRI)
        • Garbage Collection
      • Containers
        • Images
        • Container Environment
        • Runtime Class
        • Container Lifecycle Hooks
      • Workloads
        • Pods
          • Pod Lifecycle
          • Init Containers
          • Pod Topology Spread Constraints
          • Disruptions
          • Ephemeral Containers
        • Workload Resources
          • Deployments
          • ReplicaSet
          • StatefulSets
          • DaemonSet
          • Jobs
          • Automatic Clean-up for Finished Jobs
          • CronJob
          • ReplicationController
      • Services, Load Balancing, and Networking
        • Service
        • Topology-aware traffic routing with topology keys
        • DNS for Services and Pods
        • Connecting Applications with Services
        • Ingress
        • Ingress Controllers
        • EndpointSlices
        • Service Internal Traffic Policy
        • Topology Aware Hints
        • Network Policies
        • IPv4/IPv6 dual-stack
      • Storage
        • Volumes
        • Persistent Volumes
        • Projected Volumes
        • Ephemeral Volumes
        • Storage Classes
        • Dynamic Volume Provisioning
        • Volume Snapshots
        • Volume Snapshot Classes
        • CSI Volume Cloning
        • Storage Capacity
        • Node-specific Volume Limits
        • Volume Health Monitoring
      • Configuration
        • Configuration Best Practices
        • ConfigMaps
        • Secrets
        • Managing Resources for Containers
        • Organizing Cluster Access Using kubeconfig Files
      • Security
        • Overview of Cloud Native Security
        • Pod Security Standards
        • Pod Security Admission
        • Controlling Access to the Kubernetes API
      • Policies
        • Limit Ranges
        • Resource Quotas
        • Pod Security Policies
        • Process ID Limits And Reservations
        • Node Resource Managers
      • Scheduling, Preemption and Eviction
        • Kubernetes Scheduler
        • Assigning Pods to Nodes
        • Pod Overhead
        • Taints and Tolerations
        • Pod Priority and Preemption
        • Node-pressure Eviction
        • API-initiated Eviction
        • Resource Bin Packing for Extended Resources
        • Scheduling Framework
        • Scheduler Performance Tuning
      • Cluster Administration
        • Certificates
        • Managing Resources
        • Cluster Networking
        • Logging Architecture
        • Metrics For Kubernetes System Components
        • System Logs
        • Traces For Kubernetes System Components
        • Proxies in Kubernetes
        • API Priority and Fairness
        • Installing Addons
      • Extending Kubernetes
        • Extending the Kubernetes API
          • Custom Resources
          • Kubernetes API Aggregation Layer
        • Compute, Storage, and Networking Extensions
          • Network Plugins
          • Device Plugins
        • Operator pattern
        • Service Catalog
    • Tasks
      • Install Tools
        • Install and Set Up kubectl on Linux
        • Install and Set Up kubectl on macOS
        • Install and Set Up kubectl on Windows
      • Administer a Cluster
        • Administration with kubeadm
          • Certificate Management with kubeadm
          • Configuring a cgroup driver
          • Upgrading kubeadm clusters
          • Adding Windows nodes
          • Upgrading Windows nodes
        • Migrating from dockershim
          • Find Out What Container Runtime is Used on a Node
          • Check whether Dockershim deprecation affects you
          • Migrating telemetry and security agents from dockershim
        • Certificates
        • Manage Memory, CPU, and API Resources
          • Configure Default Memory Requests and Limits for a Namespace
          • Configure Default CPU Requests and Limits for a Namespace
          • Configure Minimum and Maximum Memory Constraints for a Namespace
          • Configure Minimum and Maximum CPU Constraints for a Namespace
          • Configure Memory and CPU Quotas for a Namespace
          • Configure a Pod Quota for a Namespace
        • Install a Network Policy Provider
          • Use Antrea for NetworkPolicy
          • Use Calico for NetworkPolicy
          • Use Cilium for NetworkPolicy
          • Use Kube-router for NetworkPolicy
          • Romana for NetworkPolicy
          • Weave Net for NetworkPolicy
        • Access Clusters Using the Kubernetes API
        • Access Services Running on Clusters
        • Advertise Extended Resources for a Node
        • Autoscale the DNS Service in a Cluster
        • Change the default StorageClass
        • Change the Reclaim Policy of a PersistentVolume
        • Cloud Controller Manager Administration
        • Configure Quotas for API Objects
        • Control CPU Management Policies on the Node
        • Control Topology Management Policies on a node
        • Customizing DNS Service
        • Debugging DNS Resolution
        • Declare Network Policy
        • Developing Cloud Controller Manager
        • Enable Or Disable A Kubernetes API
        • Enabling Service Topology
        • Encrypting Secret Data at Rest
        • Guaranteed Scheduling For Critical Add-On Pods
        • IP Masquerade Agent User Guide
        • Limit Storage Consumption
        • Migrate Replicated Control Plane To Use Cloud Controller Manager
        • Namespaces Walkthrough
        • Operating etcd clusters for Kubernetes
        • Reconfigure a Node’s Kubelet in a Live Cluster
        • Reserve Compute Resources for System Daemons
        • Running Kubernetes Node Components as a Non-root User
        • Safely Drain a Node
        • Securing a Cluster
        • Set Kubelet parameters via a config file
        • Share a Cluster with Namespaces
        • Upgrade A Cluster
        • Use Cascading Deletion in a Cluster
        • Using a KMS provider for data encryption
        • Using CoreDNS for Service Discovery
        • Using NodeLocal DNSCache in Kubernetes clusters
        • Using sysctls in a Kubernetes Cluster
        • Utilizing the NUMA-aware Memory Manager
      • Configure Pods and Containers
        • Assign Memory Resources to Containers and Pods
        • Assign CPU Resources to Containers and Pods
        • Configure GMSA for Windows Pods and containers
        • Configure RunAsUserName for Windows pods and containers
        • Create a Windows HostProcess Pod
        • Configure Quality of Service for Pods
        • Assign Extended Resources to a Container
        • Configure a Pod to Use a Volume for Storage
        • Configure a Pod to Use a PersistentVolume for Storage
        • Configure a Pod to Use a Projected Volume for Storage
        • Configure a Security Context for a Pod or Container
        • Configure Service Accounts for Pods
        • Pull an Image from a Private Registry
        • Configure Liveness, Readiness and Startup Probes
        • Assign Pods to Nodes
        • Assign Pods to Nodes using Node Affinity
        • Configure Pod Initialization
        • Attach Handlers to Container Lifecycle Events
        • Configure a Pod to Use a ConfigMap
        • Share Process Namespace between Containers in a Pod
        • Create static Pods
        • Translate a Docker Compose File to Kubernetes Resources
        • Enforce Pod Security Standards by Configuring the Built-in Admission Controller
        • Enforce Pod Security Standards with Namespace Labels
        • Migrate from PodSecurityPolicy to the Built-In PodSecurity Admission Controller
      • Manage Kubernetes Objects
        • Declarative Management of Kubernetes Objects Using Configuration Files
        • Declarative Management of Kubernetes Objects Using Kustomize
        • Managing Kubernetes Objects Using Imperative Commands
        • Imperative Management of Kubernetes Objects Using Configuration Files
        • Update API Objects in Place Using kubectl patch
      • Managing Secrets
        • Managing Secrets using kubectl
        • Managing Secrets using Configuration File
        • Managing Secrets using Kustomize
      • Inject Data Into Applications
        • Define a Command and Arguments for a Container
        • Define Dependent Environment Variables
        • Define Environment Variables for a Container
        • Expose Pod Information to Containers Through Environment Variables
        • Expose Pod Information to Containers Through Files
        • Distribute Credentials Securely Using Secrets
      • Run Applications
        • Run a Stateless Application Using a Deployment
        • Run a Single-Instance Stateful Application
        • Run a Replicated Stateful Application
        • Scale a StatefulSet
        • Delete a StatefulSet
        • Force Delete StatefulSet Pods
        • Horizontal Pod Autoscaling
        • HorizontalPodAutoscaler Walkthrough
        • Specifying a Disruption Budget for your Application
        • Accessing the Kubernetes API from a Pod
      • Run Jobs
        • Running Automated Tasks with a CronJob
        • Coarse Parallel Processing Using a Work Queue
        • Fine Parallel Processing Using a Work Queue
        • Indexed Job for Parallel Processing with Static Work Assignment
        • Parallel Processing using Expansions
      • Access Applications in a Cluster
        • Deploy and Access the Kubernetes Dashboard
        • Accessing Clusters
        • Configure Access to Multiple Clusters
        • Use Port Forwarding to Access Applications in a Cluster
        • Use a Service to Access an Application in a Cluster
        • Connect a Frontend to a Backend Using Services
        • Create an External Load Balancer
        • List All Container Images Running in a Cluster
        • Set up Ingress on Minikube with the NGINX Ingress Controller
        • Communicate Between Containers in the Same Pod Using a Shared Volume
        • Configure DNS for a Cluster
      • Monitoring, Logging, and Debugging
        • Application Introspection and Debugging
        • Auditing
        • Debug a StatefulSet
        • Debug Init Containers
        • Debug Pods and ReplicationControllers
        • Debug Running Pods
        • Debug Services
        • Debugging Kubernetes nodes with crictl
        • Determine the Reason for Pod Failure
        • Developing and debugging services locally
        • Get a Shell to a Running Container
        • Monitor Node Health
        • Resource metrics pipeline
        • Tools for Monitoring Resources
        • Troubleshoot Applications
        • Troubleshoot Clusters
        • Troubleshooting
      • Extend Kubernetes
        • Configure the Aggregation Layer
        • Use Custom Resources
          • Extend the Kubernetes API with CustomResourceDefinitions
          • Versions in CustomResourceDefinitions
        • Set up an Extension API Server
        • Configure Multiple Schedulers
        • Use an HTTP Proxy to Access the Kubernetes API
        • Set up Konnectivity service
      • TLS
        • Configure Certificate Rotation for the Kubelet
        • Manage TLS Certificates in a Cluster
        • Manual Rotation of CA Certificates
      • Manage Cluster Daemons
        • Perform a Rolling Update on a DaemonSet
        • Perform a Rollback on a DaemonSet
      • Service Catalog
        • Install Service Catalog using Helm
        • Install Service Catalog using SC
      • Networking
        • Adding entries to Pod /etc/hosts with HostAliases
        • Validate IPv4/IPv6 dual-stack
        • Configure a kubelet image credential provider
        • Extend kubectl with plugins
        • Manage HugePages
        • Schedule GPUs
    • Tutorials
      • Hello Minikube
      • Learn Kubernetes Basics
        • Create a Cluster
          • Using Minikube to Create a Cluster
          • Interactive Tutorial - Creating a Cluster
        • Deploy an App
          • Using kubectl to Create a Deployment
          • Interactive Tutorial - Deploying an App
        • Explore Your App
          • Viewing Pods and Nodes
          • Interactive Tutorial - Exploring Your App
        • Expose Your App Publicly
          • Using a Service to Expose Your App
          • Interactive Tutorial - Exposing Your App
        • Scale Your App
          • Running Multiple Instances of Your App
          • Interactive Tutorial - Scaling Your App
        • Update Your App
          • Performing a Rolling Update
          • Interactive Tutorial - Updating Your App
      • Configuration
        • Example: Configuring a Java Microservice
          • Externalizing config using MicroProfile, ConfigMaps and Secrets
          • Interactive Tutorial - Configuring a Java Microservice
        • Configuring Redis using a ConfigMap
      • Stateless Applications
        • Exposing an External IP Address to Access an Application in a Cluster
        • Example: Deploying PHP Guestbook application with Redis
      • Stateful Applications
        • StatefulSet Basics
        • Example: Deploying WordPress and MySQL with Persistent Volumes
        • Example: Deploying Cassandra with a StatefulSet
        • Running ZooKeeper, A Distributed System Coordinator
      • Clusters
        • Restrict a Container’s Access to Resources with AppArmor
        • Restrict a Container’s Syscalls with seccomp
      • Services
        • Using Source IP
    • Reference
      • Glossary
      • API Overview
        • Kubernetes API Concepts
        • Server-Side Apply
        • Client Libraries
        • Kubernetes Deprecation Policy
        • Deprecated API Migration Guide
        • Kubernetes API health endpoints
      • API Access Control
        • Authenticating
        • Authenticating with Bootstrap Tokens
        • Certificate Signing Requests
        • Using Admission Controllers
        • Dynamic Admission Control
        • Managing Service Accounts
        • Authorization Overview
        • Using RBAC Authorization
        • Using ABAC Authorization
        • Using Node Authorization
        • Webhook Mode
      • Well-Known Labels, Annotations and Taints
      • Kubernetes API
        • Workload Resources
          • Pod
          • PodTemplate
          • ReplicationController
          • ReplicaSet
          • Deployment
          • StatefulSet
          • ControllerRevision
          • DaemonSet
          • Job
          • CronJob
          • HorizontalPodAutoscaler
          • HorizontalPodAutoscaler v2beta2
          • PriorityClass
        • Service Resources
          • Service
          • Endpoints
          • EndpointSlice
          • Ingress
          • IngressClass
        • Config and Storage Resources
          • ConfigMap
          • Secret
          • Volume
          • PersistentVolumeClaim
          • PersistentVolume
          • StorageClass
          • VolumeAttachment
          • CSIDriver
          • CSINode
          • CSIStorageCapacity v1beta1
        • Authentication Resources
          • ServiceAccount
          • TokenRequest
          • TokenReview
          • CertificateSigningRequest
        • Authorization Resources
          • LocalSubjectAccessReview
          • SelfSubjectAccessReview
          • SelfSubjectRulesReview
          • SubjectAccessReview
          • ClusterRole
          • ClusterRoleBinding
          • Role
          • RoleBinding
        • Policy Resources
          • LimitRange
          • ResourceQuota
          • NetworkPolicy
          • PodDisruptionBudget
          • PodSecurityPolicy v1beta1
        • Extend Resources
          • CustomResourceDefinition
          • MutatingWebhookConfiguration
          • ValidatingWebhookConfiguration
        • Cluster Resources
          • Node
          • Namespace
          • Event
          • APIService
          • Lease
          • RuntimeClass
          • FlowSchema v1beta1
          • PriorityLevelConfiguration v1beta1
          • Binding
          • ComponentStatus
        • Common Definitions
          • DeleteOptions
          • LabelSelector
          • ListMeta
          • LocalObjectReference
          • NodeSelectorRequirement
          • ObjectFieldSelector
          • ObjectMeta
          • ObjectReference
          • Patch
          • Quantity
          • ResourceFieldSelector
          • Status
          • TypedLocalObjectReference
          • Common Parameters
      • Kubernetes Issues and Security
        • Kubernetes Issue Tracker
        • Kubernetes Security and Disclosure Information
      • Ports and Protocols
      • Setup tools
        • Kubeadm
          • kubeadm init
          • kubeadm join
          • kubeadm upgrade
          • kubeadm config
          • kubeadm reset
          • kubeadm token
          • kubeadm version
          • kubeadm alpha
          • kubeadm certs
          • kubeadm init phase
          • kubeadm join phase
          • kubeadm kubeconfig
          • kubeadm reset phase
          • kubeadm upgrade phase
          • Implementation details
      • Component tools
        • Feature Gates
        • kubelet
        • kube-apiserver
        • kube-controller-manager
        • kube-proxy
        • kube-scheduler
        • Kubelet authentication/authorization
        • TLS bootstrapping
      • kubectl
        • Overview of kubectl
        • JSONPath Support
        • kubectl
        • kubectl Cheat Sheet
        • kubectl Commands
          • GETTING STARTED
          • create
          • get
          • run
          • expose
          • delete
          • APP MANAGEMENT
          • apply
          • annotate
          • autoscale
          • debug
          • diff
          • edit
          • kustomize
          • label
          • patch
          • replace
          • rollout
          • scale
          • set
          • wait
          • WORKING WITH APPS
          • attach
          • auth
          • cp
          • describe
          • exec
          • logs
          • port-forward
          • proxy
          • top
          • CLUSTER MANAGEMENT
          • api-versions
          • certificate
          • cluster-info
          • cordon
          • drain
          • taint
          • uncordon
          • KUBECTL SETTINGS AND USAGE
          • alpha
          • api-resources
          • completion
          • config
          • explain
          • options
          • plugin
          • version
        • kubectl for Docker Users
        • kubectl Usage Conventions
      • Configuration APIs
        • Client Authentication (v1beta1)
        • kube-apiserver Audit Configuration (v1)
        • kube-apiserver Configuration (v1beta1)
        • kube-proxy Configuration (v1alpha1)
        • kube-scheduler Configuration (v1beta1)
        • kube-scheduler Configuration (v1beta2)
        • kube-scheduler Configuration (v1beta3)
        • kube-scheduler Policy Configuration (v1)
        • kubeadm Configuration (v1beta2)
        • kubeadm Configuration (v1beta3)
        • Kubelet Configuration (v1beta1)
        • WebhookAdmission Configuration (v1)
      • Scheduling
        • Scheduler Configuration
        • Scheduling Policies
      • Other Tools
    • Contribute
      • Suggesting content improvements
      • Contributing new content
        • Opening a pull request
        • Documenting for a release
        • Blogs and case studies
      • Reviewing changes
        • Reviewing pull requests
        • For approvers and reviewers
      • Localizing Kubernetes documentation
      • Participating in SIG Docs
        • Roles and responsibilities
        • PR wranglers
      • Documentation style overview
        • Content guide
        • Style guide
        • Writing a new topic
        • Page content types
        • Content organization
        • Custom Hugo Shortcodes
      • Reference Docs Overview
        • Contributing to the Upstream Kubernetes Code
        • Quickstart
        • Generating Reference Documentation for the Kubernetes API
        • Generating Reference Documentation for kubectl Commands
        • Generating Reference Pages for Kubernetes Components and Tools
      • Advanced contributing
      • Viewing Site Analytics
    • Docs smoke test page
    暂无相关搜索结果！

      本文档使用 BookStack 构建

      展开/收起文章目录

      分享，让知识传承更久远

      文章二维码

      手机扫一扫，轻松掌上读

      文档下载

      • 普通下载
      • 下载码下载(免登录无限下载)
      你与大神的距离，只差一个APP
      APP下载
      请下载您需要的格式的文档，随时随地，享受汲取知识的乐趣！
      PDF文档 EPUB文档 MOBI文档
      温馨提示 每天每在网站阅读学习一分钟时长可下载一本电子书，每天连续签到可增加阅读时长
      下载码方式下载：免费、免登录、无限制。 免费获取下载码

      微信小程序阅读

      BookChat 微信小程序阅读
      您与他人的薪资差距，只差一个随时随地学习的小程序

      书签列表

        阅读记录

        阅读进度: 0.00% ( 0/0 ) 重置阅读进度