docs update

kubernetes-sigs · Sep 23, 2020 · b46eb86 · b46eb86
1 parent 08095a3
commit b46eb86
Show file tree

Hide file tree

Showing 561 changed files with 194,745 additions and 190 deletions.
diff --git a/docs/404.html b/docs/404.html
diff --git a/docs/css/swagger-ui.css b/docs/css/swagger-ui.css
diff --git a/docs/documentation/app_deployment/accessing_multiple_clusters/index.html b/docs/documentation/app_deployment/accessing_multiple_clusters/index.html
diff --git a/docs/documentation/app_deployment/diffing_local_and_remote_resources/index.html b/docs/documentation/app_deployment/diffing_local_and_remote_resources/index.html
diff --git a/docs/documentation/app_deployment/index.html b/docs/documentation/app_deployment/index.html
diff --git a/docs/documentation/app_deployment/index.xml b/docs/documentation/app_deployment/index.xml
diff --git a/docs/documentation/app_deployment/publishing_bases/index.html b/docs/documentation/app_deployment/publishing_bases/index.html
diff --git a/docs/documentation/app_management/apply/index.html b/docs/documentation/app_management/apply/index.html
diff --git a/docs/documentation/app_management/container_images/index.html b/docs/documentation/app_management/container_images/index.html
diff --git a/docs/documentation/app_management/field_merge_semantics/index.html b/docs/documentation/app_management/field_merge_semantics/index.html
diff --git a/docs/documentation/app_management/index.html b/docs/documentation/app_management/index.html
diff --git a/docs/documentation/app_management/index.xml b/docs/documentation/app_management/index.xml
diff --git a/docs/documentation/app_management/introduction/index.html b/docs/documentation/app_management/introduction/index.html
diff --git a/docs/documentation/app_management/labels_annotations/index.html b/docs/documentation/app_management/labels_annotations/index.html
diff --git a/docs/documentation/app_management/namespaces_names/index.html b/docs/documentation/app_management/namespaces_names/index.html
diff --git a/docs/documentation/app_management/secrets_configmaps/index.html b/docs/documentation/app_management/secrets_configmaps/index.html
diff --git a/docs/documentation/background_information/getting_started/index.html b/docs/documentation/background_information/getting_started/index.html
diff --git a/docs/documentation/background_information/index.html b/docs/documentation/background_information/index.html
diff --git a/docs/documentation/background_information/index.xml b/docs/documentation/background_information/index.xml
diff --git a/docs/documentation/background_information/introduction/index.html b/docs/documentation/background_information/introduction/index.html
diff --git a/docs/documentation/background_information/resources_controllers/index.html b/docs/documentation/background_information/resources_controllers/index.html
diff --git a/docs/documentation/container_debugging/container_logs/index.html b/docs/documentation/container_debugging/container_logs/index.html
diff --git a/docs/documentation/container_debugging/copying_container_files/index.html b/docs/documentation/container_debugging/copying_container_files/index.html
diff --git a/docs/documentation/container_debugging/executing_a_command_in_a_container/index.html b/docs/documentation/container_debugging/executing_a_command_in_a_container/index.html
diff --git a/docs/documentation/container_debugging/index.html b/docs/documentation/container_debugging/index.html
diff --git a/docs/documentation/container_debugging/index.xml b/docs/documentation/container_debugging/index.xml
diff --git a/docs/documentation/container_debugging/port_forward_to_pods/index.html b/docs/documentation/container_debugging/port_forward_to_pods/index.html
diff --git a/docs/documentation/container_debugging/proxying_traffic_to_services/index.html b/docs/documentation/container_debugging/proxying_traffic_to_services/index.html
diff --git a/docs/documentation/extending_kubectl/discovering_plugins/index.html b/docs/documentation/extending_kubectl/discovering_plugins/index.html
diff --git a/docs/documentation/extending_kubectl/index.html b/docs/documentation/extending_kubectl/index.html
diff --git a/docs/documentation/extending_kubectl/index.xml b/docs/documentation/extending_kubectl/index.xml
@@ -0,0 +1,110 @@
+<rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom">
+  <channel>
+    <title>SIG CLI – Extending Kubectl</title>
+    <link>https://kubernetes-sigs.github.io/cli-experimental/documentation/extending_kubectl/</link>
+    <description>Recent content in Extending Kubectl on SIG CLI</description>
+    <generator>Hugo -- gohugo.io</generator>
+
+	  <atom:link href="https://kubernetes-sigs.github.io/cli-experimental/documentation/extending_kubectl/index.xml" rel="self" type="application/rss+xml" />
+
+
+
+
+
+
+
+    <item>
+      <title>Documentation: Plugin Mechanism</title>
+      <link>https://kubernetes-sigs.github.io/cli-experimental/documentation/extending_kubectl/plugin_mechanism/</link>
+      <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
+
+      <guid>https://kubernetes-sigs.github.io/cli-experimental/documentation/extending_kubectl/plugin_mechanism/</guid>
+      <description>
+
+
+
+
+&lt;div class=&#34;alert alert-success&#34; role=&#34;alert&#34;&gt;
+&lt;h4 class=&#34;alert-heading&#34;&gt;TL;DR&lt;/h4&gt;
+&lt;ul&gt;
+&lt;li&gt;Drop executables named &lt;code&gt;kubectl-plugin_name&lt;/code&gt; on your &lt;code&gt;PATH&lt;/code&gt; and invoke with &lt;code&gt;kubectl plugin-name&lt;/code&gt;&lt;/li&gt;
+&lt;li&gt;&lt;code&gt;kubectl plugin list&lt;/code&gt; shows available plugins&lt;/li&gt;
+&lt;/ul&gt;
+
+&lt;/div&gt;
+
+&lt;h1 id=&#34;kubectl-plugins&#34;&gt;Kubectl plugins&lt;/h1&gt;
+&lt;p&gt;Kubectl plugins are a lightweight mechanism to extend &lt;code&gt;kubectl&lt;/code&gt; with custom functionality to suit your needs.&lt;/p&gt;
+&lt;h2 id=&#34;plugin-mechanism&#34;&gt;Plugin mechanism&lt;/h2&gt;
+&lt;p&gt;As of version 1.12, kubectl has a simple plugin mechanism to expose binaries on your &lt;code&gt;PATH&lt;/code&gt; as kubectl subcommands.
+When invoking an unknown subcommand &lt;code&gt;kubectl my-plugin&lt;/code&gt;, kubectl starts searching for an executable named &lt;code&gt;kubectl-my_plugin&lt;/code&gt; on your &lt;code&gt;PATH&lt;/code&gt;.
+Note how the dash is mapped to an underscore. This is to enable plugins that are invoked by multiple words, for example
+&lt;code&gt;kubectl my plugin&lt;/code&gt; would trigger a search for the commands &lt;code&gt;kubectl-my-plugin&lt;/code&gt; or &lt;code&gt;kubectl-my&lt;/code&gt;. The more specific match
+always wins over the other, so if both &lt;code&gt;kubectl-my&lt;/code&gt; and &lt;code&gt;kubectl-my-plugin&lt;/code&gt; exist, the latter will be called.
+When a matching executable is found, kubectl calls it, forwarding all extra arguments.&lt;/p&gt;
+&lt;p&gt;The reference on &lt;a href=&#34;https://kubernetes.io/docs/tasks/extend-kubectl/kubectl-plugins/&#34;&gt;kubernetes.io&lt;/a&gt; knows more.&lt;/p&gt;
+
+
+&lt;div class=&#34;alert alert-success&#34; role=&#34;alert&#34;&gt;
+&lt;h4 class=&#34;alert-heading&#34;&gt;Windows compatibility&lt;/h4&gt;
+On windows, the minimum required version to use the plugin mechanism is 1.14.
+&lt;/div&gt;
+
+&lt;p&gt;Listing installed plugins&lt;/p&gt;
+&lt;div class=&#34;highlight&#34;&gt;&lt;pre style=&#34;background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4&#34;&gt;&lt;code class=&#34;language-bash&#34; data-lang=&#34;bash&#34;&gt;kubectl plugin list
+&lt;/code&gt;&lt;/pre&gt;&lt;/div&gt;
+      </description>
+    </item>
+
+    <item>
+      <title>Documentation: Discovering Plugins</title>
+      <link>https://kubernetes-sigs.github.io/cli-experimental/documentation/extending_kubectl/discovering_plugins/</link>
+      <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
+
+      <guid>https://kubernetes-sigs.github.io/cli-experimental/documentation/extending_kubectl/discovering_plugins/</guid>
+      <description>
+
+
+
+
+&lt;div class=&#34;alert alert-success&#34; role=&#34;alert&#34;&gt;
+&lt;h4 class=&#34;alert-heading&#34;&gt;TL;DR&lt;/h4&gt;
+&lt;ul&gt;
+&lt;li&gt;&lt;a href=&#34;https://krew.sigs.k8s.io/docs/user-guide/setup/install/&#34;&gt;krew.sigs.k8s.io&lt;/a&gt; is a kubernetes sub-project to discover and manage plugins&lt;/li&gt;
+&lt;/ul&gt;
+
+&lt;/div&gt;
+
+&lt;h1 id=&#34;krew&#34;&gt;Krew&lt;/h1&gt;
+&lt;p&gt;By design, &lt;code&gt;kubectl&lt;/code&gt; does not install plugins. This task is left to the kubernetes sub-project
+&lt;a href=&#34;https://krew.sigs.k8s.io/docs/user-guide/setup/install/&#34;&gt;krew.sigs.k8s.io&lt;/a&gt; which needs to be installed separately.
+Krew helps to&lt;/p&gt;
+&lt;ul&gt;
+&lt;li&gt;discover plugins&lt;/li&gt;
+&lt;li&gt;get updates for installed plugins&lt;/li&gt;
+&lt;li&gt;remove plugins&lt;/li&gt;
+&lt;/ul&gt;
+&lt;h2 id=&#34;installing-krew&#34;&gt;Installing krew&lt;/h2&gt;
+&lt;p&gt;Krew should be used as a kubectl plugin. To set yourself up to using krew, you need to do two things:&lt;/p&gt;
+&lt;ol&gt;
+&lt;li&gt;Install git&lt;/li&gt;
+&lt;li&gt;Install krew as described on the project page &lt;a href=&#34;https://krew.sigs.k8s.io/docs/user-guide/setup/install/&#34;&gt;krew.sigs.k8s.io&lt;/a&gt;.&lt;/li&gt;
+&lt;li&gt;Add the krew bin folder to your &lt;code&gt;PATH&lt;/code&gt; environment variable. For example, in bash &lt;code&gt;export PATH=&amp;quot;${KREW_ROOT:-$HOME/.krew}/bin:$PATH&amp;quot;&lt;/code&gt;.&lt;/li&gt;
+&lt;/ol&gt;
+&lt;h2 id=&#34;krew-capabilities&#34;&gt;Krew capabilities&lt;/h2&gt;
+&lt;p&gt;Discover plugins&lt;/p&gt;
+&lt;div class=&#34;highlight&#34;&gt;&lt;pre style=&#34;background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4&#34;&gt;&lt;code class=&#34;language-bash&#34; data-lang=&#34;bash&#34;&gt;kubectl krew search
+&lt;/code&gt;&lt;/pre&gt;&lt;/div&gt;&lt;p&gt;Install a plugin&lt;/p&gt;
+&lt;div class=&#34;highlight&#34;&gt;&lt;pre style=&#34;background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4&#34;&gt;&lt;code class=&#34;language-bash&#34; data-lang=&#34;bash&#34;&gt;kubectl krew install access-matrix
+&lt;/code&gt;&lt;/pre&gt;&lt;/div&gt;&lt;p&gt;Upgrade all installed plugins&lt;/p&gt;
+&lt;div class=&#34;highlight&#34;&gt;&lt;pre style=&#34;background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4&#34;&gt;&lt;code class=&#34;language-bash&#34; data-lang=&#34;bash&#34;&gt;kubectl krew upgrade
+&lt;/code&gt;&lt;/pre&gt;&lt;/div&gt;&lt;p&gt;Show details about a plugin&lt;/p&gt;
+&lt;div class=&#34;highlight&#34;&gt;&lt;pre style=&#34;background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4&#34;&gt;&lt;code class=&#34;language-bash&#34; data-lang=&#34;bash&#34;&gt;kubectl krew info access-matrix
+&lt;/code&gt;&lt;/pre&gt;&lt;/div&gt;&lt;p&gt;Uninstall a plugin&lt;/p&gt;
+&lt;div class=&#34;highlight&#34;&gt;&lt;pre style=&#34;background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4&#34;&gt;&lt;code class=&#34;language-bash&#34; data-lang=&#34;bash&#34;&gt;kubectl krew uninstall access-matrix
+&lt;/code&gt;&lt;/pre&gt;&lt;/div&gt;
+      </description>
+    </item>
+
+  </channel>
+</rss>
diff --git a/docs/documentation/extending_kubectl/plugin_mechanism/index.html b/docs/documentation/extending_kubectl/plugin_mechanism/index.html
diff --git a/docs/documentation/index.html b/docs/documentation/index.html
diff --git a/docs/documentation/index.xml b/docs/documentation/index.xml
@@ -0,0 +1,17 @@
+<rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom">
+  <channel>
+    <title>SIG CLI – temp</title>
+    <link>https://kubernetes-sigs.github.io/cli-experimental/documentation/</link>
+    <description>Recent content in temp on SIG CLI</description>
+    <generator>Hugo -- gohugo.io</generator>
+
+	  <atom:link href="https://kubernetes-sigs.github.io/cli-experimental/documentation/index.xml" rel="self" type="application/rss+xml" />
+
+
+
+
+
+
+
+  </channel>
+</rss>
diff --git a/docs/documentation/misc_imperative_commands/creating_resources/index.html b/docs/documentation/misc_imperative_commands/creating_resources/index.html
diff --git a/docs/documentation/misc_imperative_commands/editing_workloads/index.html b/docs/documentation/misc_imperative_commands/editing_workloads/index.html
diff --git a/docs/documentation/misc_imperative_commands/index.html b/docs/documentation/misc_imperative_commands/index.html