Skip to content

Commit b46eb86

Browse files
SyamSundarKirubakaranSyamSundarKirubakaran
committed
docs update
1 parent 08095a3 commit b46eb86

File tree

561 files changed

+194745
-190
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

561 files changed

+194745
-190
lines changed

‎docs/404.html

Lines changed: 162 additions & 0 deletions
Large diffs are not rendered by default.

‎docs/css/swagger-ui.css

Lines changed: 4 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎docs/documentation/app_deployment/accessing_multiple_clusters/index.html

Lines changed: 791 additions & 0 deletions
Large diffs are not rendered by default.

‎docs/documentation/app_deployment/diffing_local_and_remote_resources/index.html

Lines changed: 738 additions & 0 deletions
Large diffs are not rendered by default.

‎docs/documentation/app_deployment/index.html

Lines changed: 791 additions & 0 deletions
Large diffs are not rendered by default.

‎docs/documentation/app_deployment/index.xml

Lines changed: 236 additions & 0 deletions
Large diffs are not rendered by default.

‎docs/documentation/app_deployment/publishing_bases/index.html

Lines changed: 779 additions & 0 deletions
Large diffs are not rendered by default.

‎docs/documentation/app_management/apply/index.html

Lines changed: 829 additions & 0 deletions
Large diffs are not rendered by default.

‎docs/documentation/app_management/container_images/index.html

Lines changed: 882 additions & 0 deletions
Large diffs are not rendered by default.

‎docs/documentation/app_management/field_merge_semantics/index.html

Lines changed: 1237 additions & 0 deletions
Large diffs are not rendered by default.

‎docs/documentation/app_management/index.html

Lines changed: 819 additions & 0 deletions
Large diffs are not rendered by default.

‎docs/documentation/app_management/index.xml

Lines changed: 1668 additions & 0 deletions
Large diffs are not rendered by default.

‎docs/documentation/app_management/introduction/index.html

Lines changed: 737 additions & 0 deletions
Large diffs are not rendered by default.

‎docs/documentation/app_management/labels_annotations/index.html

Lines changed: 882 additions & 0 deletions
Large diffs are not rendered by default.

‎docs/documentation/app_management/namespaces_names/index.html

Lines changed: 948 additions & 0 deletions
Large diffs are not rendered by default.

‎docs/documentation/app_management/secrets_configmaps/index.html

Lines changed: 1018 additions & 0 deletions
Large diffs are not rendered by default.

‎docs/documentation/background_information/getting_started/index.html

Lines changed: 812 additions & 0 deletions
Large diffs are not rendered by default.

‎docs/documentation/background_information/index.html

Lines changed: 791 additions & 0 deletions
Large diffs are not rendered by default.

‎docs/documentation/background_information/index.xml

Lines changed: 505 additions & 0 deletions
Large diffs are not rendered by default.

‎docs/documentation/background_information/introduction/index.html

Lines changed: 820 additions & 0 deletions
Large diffs are not rendered by default.

‎docs/documentation/background_information/resources_controllers/index.html

Lines changed: 956 additions & 0 deletions
Large diffs are not rendered by default.

‎docs/documentation/container_debugging/container_logs/index.html

Lines changed: 794 additions & 0 deletions
Large diffs are not rendered by default.

‎docs/documentation/container_debugging/copying_container_files/index.html

Lines changed: 757 additions & 0 deletions
Large diffs are not rendered by default.

‎docs/documentation/container_debugging/executing_a_command_in_a_container/index.html

Lines changed: 737 additions & 0 deletions
Large diffs are not rendered by default.

‎docs/documentation/container_debugging/index.html

Lines changed: 805 additions & 0 deletions
Large diffs are not rendered by default.

‎docs/documentation/container_debugging/index.xml

Lines changed: 332 additions & 0 deletions
Large diffs are not rendered by default.

‎docs/documentation/container_debugging/port_forward_to_pods/index.html

Lines changed: 737 additions & 0 deletions
Large diffs are not rendered by default.

‎docs/documentation/container_debugging/proxying_traffic_to_services/index.html

Lines changed: 765 additions & 0 deletions
Large diffs are not rendered by default.

‎docs/documentation/extending_kubectl/discovering_plugins/index.html

Lines changed: 735 additions & 0 deletions
Large diffs are not rendered by default.

‎docs/documentation/extending_kubectl/index.html

Lines changed: 784 additions & 0 deletions
Large diffs are not rendered by default.

‎docs/documentation/extending_kubectl/index.xml

Lines changed: 110 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,110 @@
1+
<rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom">
2+
<channel>
3+
<title>SIG CLI – Extending Kubectl</title>
4+
<link>https://kubernetes-sigs.github.io/cli-experimental/documentation/extending_kubectl/</link>
5+
<description>Recent content in Extending Kubectl on SIG CLI</description>
6+
<generator>Hugo -- gohugo.io</generator>
7+
8+
<atom:link href="https://kubernetes-sigs.github.io/cli-experimental/documentation/extending_kubectl/index.xml" rel="self" type="application/rss+xml" />
9+
10+
11+
12+
13+
14+
15+
16+
<item>
17+
<title>Documentation: Plugin Mechanism</title>
18+
<link>https://kubernetes-sigs.github.io/cli-experimental/documentation/extending_kubectl/plugin_mechanism/</link>
19+
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
20+
21+
<guid>https://kubernetes-sigs.github.io/cli-experimental/documentation/extending_kubectl/plugin_mechanism/</guid>
22+
<description>
23+
24+
25+
26+
27+
&lt;div class=&#34;alert alert-success&#34; role=&#34;alert&#34;&gt;
28+
&lt;h4 class=&#34;alert-heading&#34;&gt;TL;DR&lt;/h4&gt;
29+
&lt;ul&gt;
30+
&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;
31+
&lt;li&gt;&lt;code&gt;kubectl plugin list&lt;/code&gt; shows available plugins&lt;/li&gt;
32+
&lt;/ul&gt;
33+
34+
&lt;/div&gt;
35+
36+
&lt;h1 id=&#34;kubectl-plugins&#34;&gt;Kubectl plugins&lt;/h1&gt;
37+
&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;
38+
&lt;h2 id=&#34;plugin-mechanism&#34;&gt;Plugin mechanism&lt;/h2&gt;
39+
&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.
40+
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;.
41+
Note how the dash is mapped to an underscore. This is to enable plugins that are invoked by multiple words, for example
42+
&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
43+
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.
44+
When a matching executable is found, kubectl calls it, forwarding all extra arguments.&lt;/p&gt;
45+
&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;
46+
47+
48+
&lt;div class=&#34;alert alert-success&#34; role=&#34;alert&#34;&gt;
49+
&lt;h4 class=&#34;alert-heading&#34;&gt;Windows compatibility&lt;/h4&gt;
50+
On windows, the minimum required version to use the plugin mechanism is 1.14.
51+
&lt;/div&gt;
52+
53+
&lt;p&gt;Listing installed plugins&lt;/p&gt;
54+
&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
55+
&lt;/code&gt;&lt;/pre&gt;&lt;/div&gt;
56+
</description>
57+
</item>
58+
59+
<item>
60+
<title>Documentation: Discovering Plugins</title>
61+
<link>https://kubernetes-sigs.github.io/cli-experimental/documentation/extending_kubectl/discovering_plugins/</link>
62+
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
63+
64+
<guid>https://kubernetes-sigs.github.io/cli-experimental/documentation/extending_kubectl/discovering_plugins/</guid>
65+
<description>
66+
67+
68+
69+
70+
&lt;div class=&#34;alert alert-success&#34; role=&#34;alert&#34;&gt;
71+
&lt;h4 class=&#34;alert-heading&#34;&gt;TL;DR&lt;/h4&gt;
72+
&lt;ul&gt;
73+
&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;
74+
&lt;/ul&gt;
75+
76+
&lt;/div&gt;
77+
78+
&lt;h1 id=&#34;krew&#34;&gt;Krew&lt;/h1&gt;
79+
&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
80+
&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.
81+
Krew helps to&lt;/p&gt;
82+
&lt;ul&gt;
83+
&lt;li&gt;discover plugins&lt;/li&gt;
84+
&lt;li&gt;get updates for installed plugins&lt;/li&gt;
85+
&lt;li&gt;remove plugins&lt;/li&gt;
86+
&lt;/ul&gt;
87+
&lt;h2 id=&#34;installing-krew&#34;&gt;Installing krew&lt;/h2&gt;
88+
&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;
89+
&lt;ol&gt;
90+
&lt;li&gt;Install git&lt;/li&gt;
91+
&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;
92+
&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;
93+
&lt;/ol&gt;
94+
&lt;h2 id=&#34;krew-capabilities&#34;&gt;Krew capabilities&lt;/h2&gt;
95+
&lt;p&gt;Discover plugins&lt;/p&gt;
96+
&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
97+
&lt;/code&gt;&lt;/pre&gt;&lt;/div&gt;&lt;p&gt;Install a plugin&lt;/p&gt;
98+
&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
99+
&lt;/code&gt;&lt;/pre&gt;&lt;/div&gt;&lt;p&gt;Upgrade all installed plugins&lt;/p&gt;
100+
&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
101+
&lt;/code&gt;&lt;/pre&gt;&lt;/div&gt;&lt;p&gt;Show details about a plugin&lt;/p&gt;
102+
&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
103+
&lt;/code&gt;&lt;/pre&gt;&lt;/div&gt;&lt;p&gt;Uninstall a plugin&lt;/p&gt;
104+
&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
105+
&lt;/code&gt;&lt;/pre&gt;&lt;/div&gt;
106+
</description>
107+
</item>
108+
109+
</channel>
110+
</rss>

‎docs/documentation/extending_kubectl/plugin_mechanism/index.html

Lines changed: 728 additions & 0 deletions
Large diffs are not rendered by default.

‎docs/documentation/index.html

Lines changed: 806 additions & 0 deletions
Large diffs are not rendered by default.

‎docs/documentation/index.xml

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
<rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom">
2+
<channel>
3+
<title>SIG CLI – temp</title>
4+
<link>https://kubernetes-sigs.github.io/cli-experimental/documentation/</link>
5+
<description>Recent content in temp on SIG CLI</description>
6+
<generator>Hugo -- gohugo.io</generator>
7+
8+
<atom:link href="https://kubernetes-sigs.github.io/cli-experimental/documentation/index.xml" rel="self" type="application/rss+xml" />
9+
10+
11+
12+
13+
14+
15+
16+
</channel>
17+
</rss>

‎docs/documentation/misc_imperative_commands/creating_resources/index.html

Lines changed: 795 additions & 0 deletions
Large diffs are not rendered by default.

‎docs/documentation/misc_imperative_commands/editing_workloads/index.html

Lines changed: 722 additions & 0 deletions
Large diffs are not rendered by default.

‎docs/documentation/misc_imperative_commands/index.html

Lines changed: 798 additions & 0 deletions
Large diffs are not rendered by default.

0 commit comments

Comments
 (0)