kubernetes
/
kubectl
mirror of https://github.com/kubernetes/kubectl.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Copy feedback form to each page

This commit is contained in:
Phillip Wittrock 2019-05-01 17:53:00 -07:00
parent 68165a9a18
commit fcedb18fa7
42 changed files with 173 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
docs/book/README.md
View File

@ -1,10 +1,3 @@
{% panel style="info", title="TL;DR" %}
- Kubectl is the Kubernetes cli
- Kubectl provides a swiss army knife of functionality for working with Kubernetes clusters
- Kubectl may be used to deploy and manage applications on Kubernetes
- Kubectl may be used for scripting and building higher-level frameworks
{% endpanel %}
{% panel style="success", title="Feedback and Contributing" %} {% panel style="success", title="Feedback and Contributing" %}
**Provide feedback on new kubectl docs at the [survey](https://www.surveymonkey.com/r/JH35X82)** **Provide feedback on new kubectl docs at the [survey](https://www.surveymonkey.com/r/JH35X82)**
@ -12,6 +5,13 @@ See [CONTRIBUTING](https://github.com/kubernetes/kubectl/blob/master/docs/book/C
instructions on filing/fixing issues and adding new content. instructions on filing/fixing issues and adding new content.
{% endpanel %} {% endpanel %}
{% panel style="info", title="TL;DR" %}
- Kubectl is the Kubernetes cli
- Kubectl provides a swiss army knife of functionality for working with Kubernetes clusters
- Kubectl may be used to deploy and manage applications on Kubernetes
- Kubectl may be used for scripting and building higher-level frameworks
{% endpanel %}
# Kubectl # Kubectl
Kubectl is the Kubernetes cli version of a swiss army knife, and can do many things. Kubectl is the Kubernetes cli version of a swiss army knife, and can do many things.

4
docs/book/pages/app_composition_and_deployment/accessing_multiple_clusters.md
View File

@ -1,3 +1,7 @@
{% panel style="success", title="Providing Feedback" %}
**Provide feedback at the [survey](https://www.surveymonkey.com/r/JH35X82)**
{% endpanel %}
{% panel style="info", title="TL;DR" %} {% panel style="info", title="TL;DR" %}
- Target a cluster for a rollout with the `--context` flag - Target a cluster for a rollout with the `--context` flag
- Target a cluster for a rollout with the `--kubeconfig` flag - Target a cluster for a rollout with the `--kubeconfig` flag

4
docs/book/pages/app_composition_and_deployment/diffing_local_and_remote_resources.md
View File

@ -1,3 +1,7 @@
{% panel style="success", title="Providing Feedback" %}
**Provide feedback at the [survey](https://www.surveymonkey.com/r/JH35X82)**
{% endpanel %}
{% panel style="info", title="TL;DR" %} {% panel style="info", title="TL;DR" %}
- View diff of changes before they are Applied to the cluster - View diff of changes before they are Applied to the cluster
{% endpanel %} {% endpanel %}

4
docs/book/pages/app_composition_and_deployment/publishing_bases.md
View File

@ -1,3 +1,7 @@
{% panel style="success", title="Providing Feedback" %}
**Provide feedback at the [survey](https://www.surveymonkey.com/r/JH35X82)**
{% endpanel %}
{% panel style="warning", title="Experimental" %} {% panel style="warning", title="Experimental" %}
**Content in this chapter is experimental and will evolve based on user feedback.** **Content in this chapter is experimental and will evolve based on user feedback.**

4
docs/book/pages/app_composition_and_deployment/structure_branches.md
View File

@ -1,3 +1,7 @@
{% panel style="success", title="Providing Feedback" %}
**Provide feedback at the [survey](https://www.surveymonkey.com/r/JH35X82)**
{% endpanel %}
{% panel style="warning", title="Experimental" %} {% panel style="warning", title="Experimental" %}
**Content in this chapter is experimental and will evolve based on user feedback.** **Content in this chapter is experimental and will evolve based on user feedback.**

4
docs/book/pages/app_composition_and_deployment/structure_directories.md
View File

@ -1,3 +1,7 @@
{% panel style="success", title="Providing Feedback" %}
**Provide feedback at the [survey](https://www.surveymonkey.com/r/JH35X82)**
{% endpanel %}
{% panel style="warning", title="Experimental" %} {% panel style="warning", title="Experimental" %}
**Content in this chapter is experimental and will evolve based on user feedback.** **Content in this chapter is experimental and will evolve based on user feedback.**

4
docs/book/pages/app_composition_and_deployment/structure_introduction.md
View File

@ -1,3 +1,7 @@
{% panel style="success", title="Providing Feedback" %}
**Provide feedback at the [survey](https://www.surveymonkey.com/r/JH35X82)**
{% endpanel %}
{% panel style="info", title="TL;DR" %} {% panel style="info", title="TL;DR" %}
- Resource Config is stored in one or more git repositories - Resource Config is stored in one or more git repositories
- Directory hierarchy, git branches and git repositories may be used for loose coupling - Directory hierarchy, git branches and git repositories may be used for loose coupling

4
docs/book/pages/app_composition_and_deployment/structure_multi_tier_apps.md
View File

@ -1,3 +1,7 @@
{% panel style="success", title="Providing Feedback" %}
**Provide feedback at the [survey](https://www.surveymonkey.com/r/JH35X82)**
{% endpanel %}
{% panel style="warning", title="Experimental" %} {% panel style="warning", title="Experimental" %}
**Content in this chapter is experimental and will evolve based on user feedback.** **Content in this chapter is experimental and will evolve based on user feedback.**

4
docs/book/pages/app_composition_and_deployment/structure_repositories.md
View File

@ -1,3 +1,7 @@
{% panel style="success", title="Providing Feedback" %}
**Provide feedback at the [survey](https://www.surveymonkey.com/r/JH35X82)**
{% endpanel %}
{% panel style="warning", title="Experimental" %} {% panel style="warning", title="Experimental" %}
**Content in this chapter is experimental and will evolve based on user feedback.** **Content in this chapter is experimental and will evolve based on user feedback.**

6
docs/book/pages/app_customization/bases_and_variants.md
View File

@ -1,9 +1,15 @@
{% panel style="success", title="Providing Feedback" %}
**Provide feedback at the [survey](https://www.surveymonkey.com/r/C855WZW)**
{% endpanel %}
{% panel style="info", title="TL;DR" %} {% panel style="info", title="TL;DR" %}
- Reuse Resource Config as Bases to `kustomization.yaml`'s. - Reuse Resource Config as Bases to `kustomization.yaml`'s.
- Customize Base for different Environments. - Customize Base for different Environments.
- Reuse a Base across multiple Projects. - Reuse a Base across multiple Projects.
{% endpanel %} {% endpanel %}
# Bases and Variations # Bases and Variations
## Motivation ## Motivation

4
docs/book/pages/app_customization/config_reflection.md
View File

@ -1,3 +1,7 @@
{% panel style="success", title="Providing Feedback" %}
**Provide feedback at the [survey](https://www.surveymonkey.com/r/C855WZW)**
{% endpanel %}
{% panel style="info", title="TL;DR" %} {% panel style="info", title="TL;DR" %}
- Inject the values of other Resource Config fields into Pod Env Vars and Command Args with `vars`. - Inject the values of other Resource Config fields into Pod Env Vars and Command Args with `vars`.
{% endpanel %} {% endpanel %}

4
docs/book/pages/app_customization/customizing_arbitrary_fields.md
View File

@ -1,3 +1,7 @@
{% panel style="success", title="Providing Feedback" %}
**Provide feedback at the [survey](https://www.surveymonkey.com/r/C855WZW)**
{% endpanel %}
{% panel style="info", title="TL;DR" %} {% panel style="info", title="TL;DR" %}
- Customize arbitrary fields from arbitrary Resources in a Base. - Customize arbitrary fields from arbitrary Resources in a Base.
{% endpanel %} {% endpanel %}

4
docs/book/pages/app_customization/customizing_metadata.md
View File

@ -1,3 +1,7 @@
{% panel style="success", title="Providing Feedback" %}
**Provide feedback at the [survey](https://www.surveymonkey.com/r/C855WZW)**
{% endpanel %}
{% panel style="info", title="TL;DR" %} {% panel style="info", title="TL;DR" %}
- Customize Base Resource Namespaces - Customize Base Resource Namespaces
- Customize Base Resource Names with Prefixes or Suffixes - Customize Base Resource Names with Prefixes or Suffixes

4
docs/book/pages/app_customization/customizing_pod_templates.md
View File

@ -1,3 +1,7 @@
{% panel style="success", title="Providing Feedback" %}
**Provide feedback at the [survey](https://www.surveymonkey.com/r/C855WZW)**
{% endpanel %}
{% panel style="info", title="TL;DR" %} {% panel style="info", title="TL;DR" %}
- Override Base Pod and PodTemplate Image **Names** and **Tags** - Override Base Pod and PodTemplate Image **Names** and **Tags**
- Override Base Pod and PodTemplate Environment Variables and Arguments - Override Base Pod and PodTemplate Environment Variables and Arguments

4
docs/book/pages/app_customization/introduction.md
View File

@ -1,3 +1,7 @@
{% panel style="success", title="Providing Feedback" %}
**Provide feedback at the [survey](https://www.surveymonkey.com/r/C855WZW)**
{% endpanel %}
# Introduction # Introduction
This section of the book covers how to build Projects and Applications with Config This section of the book covers how to build Projects and Applications with Config

4
docs/book/pages/app_management/apply.md
View File

@ -1,3 +1,7 @@
{% panel style="success", title="Providing Feedback" %}
**Provide feedback at the [survey](https://www.surveymonkey.com/r/CLQBQHR)**
{% endpanel %}
{% panel style="info", title="TL;DR" %} {% panel style="info", title="TL;DR" %}
- Apply Creates and Updates Resources in a cluster through running `kubectl apply` on Resource Config. - Apply Creates and Updates Resources in a cluster through running `kubectl apply` on Resource Config.
- Apply manages complexity such as ordering of operations and merging user defined and cluster defined state. - Apply manages complexity such as ordering of operations and merging user defined and cluster defined state.

4
docs/book/pages/app_management/container_images.md
View File

@ -1,3 +1,7 @@
{% panel style="success", title="Providing Feedback" %}
**Provide feedback at the [survey](https://www.surveymonkey.com/r/CLQBQHR)**
{% endpanel %}
{% panel style="info", title="TL;DR" %} {% panel style="info", title="TL;DR" %}
- Override or set the Name and Tag for Container Images - Override or set the Name and Tag for Container Images
{% endpanel %} {% endpanel %}

4
docs/book/pages/app_management/field_merge_semantics.md
View File

@ -1,3 +1,7 @@
{% panel style="success", title="Providing Feedback" %}
**Provide feedback at the [survey](https://www.surveymonkey.com/r/CLQBQHR)**
{% endpanel %}
{% panel style="info", title="TL;DR" %} {% panel style="info", title="TL;DR" %}
- Fields set and deleted from Resource Config are merged into Resources by Apply - Fields set and deleted from Resource Config are merged into Resources by Apply
- If a Resource already exists, Apply updates the Resources by merging the local Resource Config into the remote Resources - If a Resource already exists, Apply updates the Resources by merging the local Resource Config into the remote Resources

4
docs/book/pages/app_management/introduction.md
View File

@ -1,3 +1,7 @@
{% panel style="success", title="Providing Feedback" %}
**Provide feedback at the [survey](https://www.surveymonkey.com/r/CLQBQHR)**
{% endpanel %}
{% panel style="info", title="TL;DR" %} {% panel style="info", title="TL;DR" %}
- Apply manages Applications through files defining Kubernetes Resources (i.e. Resource Config) - Apply manages Applications through files defining Kubernetes Resources (i.e. Resource Config)
- Kustomize is used to author Resource Config - Kustomize is used to author Resource Config

4
docs/book/pages/app_management/labels_and_annotations.md
View File

@ -1,3 +1,7 @@
{% panel style="success", title="Providing Feedback" %}
**Provide feedback at the [survey](https://www.surveymonkey.com/r/CLQBQHR)**
{% endpanel %}
{% panel style="info", title="TL;DR" %} {% panel style="info", title="TL;DR" %}
- Set Labels for all Resources declared within a Project with `commonLables` - Set Labels for all Resources declared within a Project with `commonLables`
- Set Annotations for all Resources declared within a Project with `commonAnnotations` - Set Annotations for all Resources declared within a Project with `commonAnnotations`

4
docs/book/pages/app_management/namespaces_and_names.md
View File

@ -1,3 +1,7 @@
{% panel style="success", title="Providing Feedback" %}
**Provide feedback at the [survey](https://www.surveymonkey.com/r/CLQBQHR)**
{% endpanel %}
{% panel style="info", title="TL;DR" %} {% panel style="info", title="TL;DR" %}
- Set the Namespace for all Resources within a Project with `namespace` - Set the Namespace for all Resources within a Project with `namespace`
- Prefix the Names of all Resources within a Project with `namePrefix` - Prefix the Names of all Resources within a Project with `namePrefix`

4
docs/book/pages/app_management/secrets_and_configmaps.md
View File

@ -1,3 +1,7 @@
{% panel style="success", title="Providing Feedback" %}
**Provide feedback at the [survey](https://www.surveymonkey.com/r/CLQBQHR)**
{% endpanel %}
{% panel style="info", title="TL;DR" %} {% panel style="info", title="TL;DR" %}
- Generate Secrets from files and literals with `secretGenerator` - Generate Secrets from files and literals with `secretGenerator`
- Generate ConfigMaps from files and literals with `configMapGenerator` - Generate ConfigMaps from files and literals with `configMapGenerator`

4
docs/book/pages/container_debugging/container_logs.md
View File

@ -1,3 +1,7 @@
{% panel style="success", title="Providing Feedback" %}
**Provide feedback at the [survey](https://www.surveymonkey.com/r/JH35X82)**
{% endpanel %}
{% panel style="info", title="TL;DR" %} {% panel style="info", title="TL;DR" %}
- Print the Logs of a Container in a cluster - Print the Logs of a Container in a cluster
{% endpanel %} {% endpanel %}

4
docs/book/pages/container_debugging/copying_container_files.md
View File

@ -1,3 +1,7 @@
{% panel style="success", title="Providing Feedback" %}
**Provide feedback at the [survey](https://www.surveymonkey.com/r/JH35X82)**
{% endpanel %}
{% panel style="info", title="TL;DR" %} {% panel style="info", title="TL;DR" %}
- Copy files to and from Containers in a cluster - Copy files to and from Containers in a cluster
{% endpanel %} {% endpanel %}

4
docs/book/pages/container_debugging/executing_a_command_in_a_container.md
View File

@ -1,3 +1,7 @@
{% panel style="success", title="Providing Feedback" %}
**Provide feedback at the [survey](https://www.surveymonkey.com/r/JH35X82)**
{% endpanel %}
{% panel style="info", title="TL;DR" %} {% panel style="info", title="TL;DR" %}
- Execute a Command in a Container - Execute a Command in a Container
- Get a Shell in a Container - Get a Shell in a Container

4
docs/book/pages/container_debugging/port_forward_to_pods.md
View File

@ -1,3 +1,7 @@
{% panel style="success", title="Providing Feedback" %}
**Provide feedback at the [survey](https://www.surveymonkey.com/r/JH35X82)**
{% endpanel %}
{% panel style="info", title="TL;DR" %} {% panel style="info", title="TL;DR" %}
- Port Forward local connections to Pods running in a cluster - Port Forward local connections to Pods running in a cluster
{% endpanel %} {% endpanel %}

4
docs/book/pages/container_debugging/proxying_traffic_to_services.md
View File

@ -1,3 +1,7 @@
{% panel style="success", title="Providing Feedback" %}
**Provide feedback at the [survey](https://www.surveymonkey.com/r/JH35X82)**
{% endpanel %}
{% panel style="info", title="TL;DR" %} {% panel style="info", title="TL;DR" %}
- Proxy local connections to Services running in the cluster - Proxy local connections to Services running in the cluster
{% endpanel %} {% endpanel %}

4
docs/book/pages/examples/kustomize.md
View File

@ -1,3 +1,7 @@
{% panel style="success", title="Providing Feedback" %}
**Provide feedback at the [survey](https://www.surveymonkey.com/r/JH35X82)**
{% endpanel %}
{% panel style="info", title="TL;DR" %} {% panel style="info", title="TL;DR" %}
- Examples for `kustomization.yaml` - Examples for `kustomization.yaml`
{% endpanel %} {% endpanel %}

4
docs/book/pages/imperative_porcelain/creating_resources.md
View File

@ -1,3 +1,7 @@
{% panel style="success", title="Providing Feedback" %}
**Provide feedback at the [survey](https://www.surveymonkey.com/r/JH35X82)**
{% endpanel %}
{% panel style="info", title="TL;DR" %} {% panel style="info", title="TL;DR" %}
- Imperatively Create a Resources - Imperatively Create a Resources
{% endpanel %} {% endpanel %}

4
docs/book/pages/imperative_porcelain/editing_workloads.md
View File

@ -1,3 +1,7 @@
{% panel style="success", title="Providing Feedback" %}
**Provide feedback at the [survey](https://www.surveymonkey.com/r/JH35X82)**
{% endpanel %}
{% panel style="info", title="TL;DR" %} {% panel style="info", title="TL;DR" %}
- Edit a live Resource in an editor - Edit a live Resource in an editor
{% endpanel %} {% endpanel %}

4
docs/book/pages/imperative_porcelain/introduction.md
View File

@ -1,3 +1,7 @@
{% panel style="success", title="Providing Feedback" %}
**Provide feedback at the [survey](https://www.surveymonkey.com/r/JH35X82)**
{% endpanel %}
# Introduction # Introduction
While Declarative Management of Applications is the recommended pattern for production While Declarative Management of Applications is the recommended pattern for production

4
docs/book/pages/imperative_porcelain/setting_fields.md
View File

@ -1,3 +1,7 @@
{% panel style="success", title="Providing Feedback" %}
**Provide feedback at the [survey](https://www.surveymonkey.com/r/JH35X82)**
{% endpanel %}
{% panel style="info", title="TL;DR" %} {% panel style="info", title="TL;DR" %}
- Imperatively Set fields on Resources - Imperatively Set fields on Resources
{% endpanel %} {% endpanel %}

4
docs/book/pages/kubectl_book/getting_started.md
View File

@ -1,3 +1,7 @@
{% panel style="success", title="Providing Feedback" %}
**Provide feedback at the [survey](https://www.surveymonkey.com/r/JH35X82)**
{% endpanel %}
{% panel style="info", title="TL;DR" %} {% panel style="info", title="TL;DR" %}
- Creating Resources - Creating Resources
- Printing Resources - Printing Resources

4
docs/book/pages/kubectl_book/resources_and_controllers.md
View File

@ -1,3 +1,7 @@
{% panel style="success", title="Providing Feedback" %}
**Provide feedback at the [survey](https://www.surveymonkey.com/r/JH35X82)**
{% endpanel %}
{% panel style="info", title="TL;DR" %} {% panel style="info", title="TL;DR" %}
- A Kubernetes API has 2 parts - a Resource Type and a Controller - A Kubernetes API has 2 parts - a Resource Type and a Controller
- Resources are objects declared as json or yaml and written to a cluster - Resources are objects declared as json or yaml and written to a cluster

4
docs/book/pages/reference/kustomize.md
View File

@ -1,3 +1,7 @@
{% panel style="success", title="Providing Feedback" %}
**Provide feedback at the [survey](https://www.surveymonkey.com/r/JH35X82)**
{% endpanel %}
{% panel style="info", title="TL;DR" %} {% panel style="info", title="TL;DR" %}
- Reference for `kustomization.yaml` - Reference for `kustomization.yaml`
{% endpanel %} {% endpanel %}

4
docs/book/pages/resource_printing/cluster_information.md
View File

@ -1,3 +1,7 @@
{% panel style="success", title="Providing Feedback" %}
**Provide feedback at the [survey](https://www.surveymonkey.com/r/JH35X82)**
{% endpanel %}
{% panel style="info", title="TL;DR" %} {% panel style="info", title="TL;DR" %}
- Print information about the Cluster and Client versions - Print information about the Cluster and Client versions
- Print information about the Control Plane - Print information about the Control Plane

4
docs/book/pages/resource_printing/describe.md
View File

@ -1,3 +1,7 @@
{% panel style="success", title="Providing Feedback" %}
**Provide feedback at the [survey](https://www.surveymonkey.com/r/JH35X82)**
{% endpanel %}
{% panel style="info", title="TL;DR" %} {% panel style="info", title="TL;DR" %}
- Print verbose debug information about a Resource - Print verbose debug information about a Resource
{% endpanel %} {% endpanel %}

4
docs/book/pages/resource_printing/fields.md
View File

@ -1,3 +1,7 @@
{% panel style="success", title="Providing Feedback" %}
**Provide feedback at the [survey](https://www.surveymonkey.com/r/JH35X82)**
{% endpanel %}
{% panel style="info", title="TL;DR" %} {% panel style="info", title="TL;DR" %}
- Format and print specific fields from Resources - Format and print specific fields from Resources
- Use when scripting with Get - Use when scripting with Get

4
docs/book/pages/resource_printing/queries_and_options.md
View File

@ -1,3 +1,7 @@
{% panel style="success", title="Providing Feedback" %}
**Provide feedback at the [survey](https://www.surveymonkey.com/r/JH35X82)**
{% endpanel %}
{% panel style="info", title="TL;DR" %} {% panel style="info", title="TL;DR" %}
- Queries for Getting or Describing Resources - Queries for Getting or Describing Resources
{% endpanel %} {% endpanel %}

4
docs/book/pages/resource_printing/raw.md
View File

@ -1,3 +1,7 @@
{% panel style="success", title="Providing Feedback" %}
**Provide feedback at the [survey](https://www.surveymonkey.com/r/JH35X82)**
{% endpanel %}
{% panel style="info", title="TL;DR" %} {% panel style="info", title="TL;DR" %}
- Get or List Raw Resources in a cluster as Yaml or Json - Get or List Raw Resources in a cluster as Yaml or Json
{% endpanel %} {% endpanel %}

4
docs/book/pages/resource_printing/summaries.md
View File

@ -1,3 +1,7 @@
{% panel style="success", title="Providing Feedback" %}
**Provide feedback at the [survey](https://www.surveymonkey.com/r/JH35X82)**
{% endpanel %}
{% panel style="info", title="TL;DR" %} {% panel style="info", title="TL;DR" %}
- Get a Summary of Resources Running in the Cluster - Get a Summary of Resources Running in the Cluster
{% endpanel %} {% endpanel %}

4
docs/book/pages/resource_printing/watch.md
View File

@ -1,3 +1,7 @@
{% panel style="success", title="Providing Feedback" %}
**Provide feedback at the [survey](https://www.surveymonkey.com/r/JH35X82)**
{% endpanel %}
{% panel style="info", title="TL;DR" %} {% panel style="info", title="TL;DR" %}
- Continuously Watch and print Resources as they change - Continuously Watch and print Resources as they change
{% endpanel %} {% endpanel %}