Skip to content

Commit afcad52

Browse files
author
Eviatar
committed
Init
0 parents  commit afcad52

Some content is hidden

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

43 files changed

+4178
-0
lines changed

‎API_TABLE.md

+201
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,201 @@
1+
# Kubelet's API
2+
<table>
3+
<tbody>
4+
<tr>
5+
<th>Kubelet API </th>
6+
<th align="center">HTTP request</th>
7+
<th align="center">Description</th>
8+
</tr>
9+
<tr>
10+
<td>
11+
<code class="rich-diff-level-one">
12+
/stats
13+
</code>
14+
</td>
15+
<td align="left">
16+
<pre>GET /stats<br>
17+
GET /stats/summary <br>
18+
GET /stats/summary?only_cpu_and_memory=true<br>
19+
GET /stats/container <br>
20+
GET /stats/{namespace}/{podName}/{uid}/{containerName} <br>
21+
GET /stats/{podName}/{containerName} </code>
22+
</td>
23+
<td align="left" >Return the performance stats of node, pods and containers</td>
24+
</tr>
25+
<tr>
26+
<td>
27+
<code class="rich-diff-level-one">
28+
/metrics
29+
</code>
30+
</td>
31+
<td align="left">
32+
<pre>GET /metrics<br>
33+
GET /metrics/cadvisor<br>
34+
GET /metrics/probes<br>
35+
GET /metrics/resource/v1alpha1</pre>
36+
</td>
37+
<td align="left" >Return information about node CPU and memory usage</td>
38+
</tr>
39+
<tr>
40+
<td>
41+
<code class="rich-diff-level-one">
42+
/logs
43+
</code>
44+
</td>
45+
<td align="left">
46+
<pre>GET /logs<br>
47+
GET /logs/{subpath} </pre>
48+
</td>
49+
<td align="left" >Logs from the node</td>
50+
</tr>
51+
<tr>
52+
<td>
53+
<code class="rich-diff-level-one">
54+
/spec
55+
</code>
56+
</td>
57+
<td align="left">
58+
<pre>GET /spec</pre>
59+
</td>
60+
<td align="left" >Cached MachineInfo returned by cadvisor</td>
61+
</tr>
62+
<tr>
63+
<td>
64+
<code class="rich-diff-level-one">
65+
/pods
66+
</code>
67+
</td>
68+
<td align="left">
69+
<pre>GET /pods</pre>
70+
</td>
71+
<td align="left" >List of pods</td>
72+
</tr>
73+
<tr>
74+
<td>
75+
<code class="rich-diff-level-one">
76+
/healthz
77+
</code>
78+
</td>
79+
<td align="left">
80+
<pre>GET /healthz<br>
81+
GET /healthz/log <br>
82+
GET /healthz/ping<br>
83+
GET /healthz/syncloop </pre>
84+
</td>
85+
<td align="left" >Check the state of the node</td>
86+
</tr>
87+
<tr>
88+
<td>
89+
<code class="rich-diff-level-one">
90+
/configz
91+
</code>
92+
</td>
93+
<td align="left">
94+
<pre>GET /configz</pre>
95+
</td>
96+
<td align="left" >Kubelet's configurations</td>
97+
</tr>
98+
<tr>
99+
<td>
100+
<code class="rich-diff-level-one">
101+
/containerLogs
102+
</code>
103+
</td>
104+
<td align="left">
105+
<pre>GET /containerLogs/{podNamespace}/{podID}/{containerName}</pre>
106+
</td>
107+
<td align="left" >Container's logs</td>
108+
</tr>
109+
<tr>
110+
<td>
111+
<code class="rich-diff-level-one">
112+
/run
113+
</code>
114+
</td>
115+
<td align="left">
116+
<pre>POST /run/{podNamespace}/{podID}/{containerName}<br>
117+
POST /run/{podNamespace}/{podID}/{uid}/{containerName} <br>
118+
* The body of the request: <code>"cmd={command}"</code><br>
119+
Example: <code>"cmd=ls /"</code></pre>
120+
</td>
121+
<td align="left" >Run command inside a container</td>
122+
</tr>
123+
<tr>
124+
<td>
125+
<code class="rich-diff-level-one">
126+
/exec
127+
</code>
128+
</td>
129+
<td align="left">
130+
<pre>GET /exec/{podNamespace}/{podID}/{containerName}?command={command}/&input=1&output=1&tty=1<br>
131+
POST /exec/{podNamespace}//{containerName}?command={command}/&input=1&output=1&tty=1<br>
132+
GET /exec/{podNamespace}/{podID}/{uid}/{containerName}?command={command}/&input=1&output=1&tty=1<br>
133+
POST /exec/{podNamespace}/{podID}/{uid}/{containerName}?command={command}/&input=1&output=1&tty=1</pre>
134+
</td>
135+
<td align="left" >Run command inside a container with option for stream (interactive)</td>
136+
</tr>
137+
<tr>
138+
<td>
139+
<code class="rich-diff-level-one">
140+
/cri
141+
</code>
142+
</td>
143+
<td align="left">
144+
<pre>GET /cri/exec/{valueFrom302}?cmd={command}</pre>
145+
</td>
146+
<td align="left" >Run commands inside a container through the Container Runtime Interface (CRI)</td>
147+
</tr>
148+
<tr>
149+
<td>
150+
<code class="rich-diff-level-one">
151+
/attach
152+
</code>
153+
</td>
154+
<td align="left">
155+
<pre>GET /attach/{podNamespace}/{podID}/{containerName}<br>
156+
POST /attach/{podNamespace}//{containerName}<br>
157+
GET /attach/{podNamespace}/{podID}/{uid}/{containerName}<br>
158+
POST /attach/{podNamespace}/{podID}/{uid}/{containerName}</pre>
159+
</td>
160+
<td align="left" >Attach to a container</td>
161+
</tr>
162+
<tr>
163+
<td>
164+
<code class="rich-diff-level-one">
165+
/portForward
166+
</code>
167+
</td>
168+
<td align="left">
169+
<pre>GET /portForward/{podNamespace}/{podID}/{containerName}<br>
170+
POST /portForward/{podNamespace}//{containerName}<br>
171+
GET /portForward/{podNamespace}/{podID}/{uid}/{containerName}<br>
172+
POST /portForward/{podNamespace}/{podID}/{uid}/{containerName}</pre>
173+
</td>
174+
<td align="left" >Port forwarding inside the contianer</td>
175+
</tr>
176+
<tr>
177+
<td>
178+
<code class="rich-diff-level-one">
179+
/runningpods
180+
</code>
181+
</td>
182+
<td align="left">
183+
<pre>GET /runningpods</pre>
184+
</td>
185+
<td align="left" >List all the running pods</td>
186+
</tr>
187+
<tr>
188+
<td>
189+
<code class="rich-diff-level-one">
190+
/debug
191+
</code>
192+
</td>
193+
<td align="left">
194+
<pre>GET /debug/pprof/{profile}<br>
195+
GET /debug/flags/v<br>
196+
PUT /debug/flags/v (body: {integer})</pre>
197+
</td>
198+
<td align="left" >List all the running pods</td>
199+
</tr>
200+
</tbody>
201+
</table>

‎CHANGELOG.md

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Changelog
2+
All notable changes to this project will be documented in this file.
3+
4+
The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
5+
and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
6+
7+
## [Unreleased]

‎CONTRIBUTING.md

+39
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
# Contributing
2+
3+
[Are you accepting contributions at this time? If not, please state that here.
4+
No need to include content from the rest of this document.]
5+
6+
For general contribution and community guidelines, please see the [community repo](https://github.com/cyberark/community).
7+
8+
## Table of Contents
9+
10+
- [Development](#development)
11+
- [Testing](#testing)
12+
- [Releases](#releases)
13+
- [Contributing](#contributing-workflow)
14+
15+
## Development
16+
17+
[What development tools are required to start working on this project?]
18+
19+
## Testing
20+
21+
[Instructions for running the test suite]
22+
23+
## Releases
24+
25+
[Instructions for creating a new release]
26+
27+
## Contributing workflow
28+
29+
1. [Fork the project](https://help.github.com/en/github/getting-started-with-github/fork-a-repo)
30+
2. [Clone your fork](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/cloning-a-repository)
31+
3. Make local changes to your fork by editing files
32+
3. [Commit your changes](https://help.github.com/en/github/managing-files-in-a-repository/adding-a-file-to-a-repository-using-the-command-line)
33+
4. [Push your local changes to the remote server](https://help.github.com/en/github/using-git/pushing-commits-to-a-remote-repository)
34+
5. [Create new Pull Request](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request-from-a-fork)
35+
36+
From here your pull request will be reviewed and once you've responded to all
37+
feedback it will be merged into the project. Congratulations, you're a
38+
contributor!
39+
dd

0 commit comments

Comments
 (0)