Skip to content

Commit 09a70ab

Browse files
mskalkamskalka
committed
begin reorg
0 parents  commit 09a70ab

File tree

4,845 files changed

+1626607
-0
lines changed

Some content is hidden

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

4,845 files changed

+1626607
-0
lines changed

‎.vscode/launch.json‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
{
2+
// Use IntelliSense to learn about possible attributes.
3+
// Hover to view descriptions of existing attributes.
4+
// For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
5+
"version": "0.2.0",
6+
"configurations": [
7+
{
8+
"name": "Debug Manager",
9+
"type": "go",
10+
"request": "launch",
11+
"mode": "debug",
12+
"program": "${workspaceRoot}/cmd/main.go",
13+
"buildFlags": "--ldflags '-X gitlab-master.nvidia.com/dgx/infra/skyhook-operator/internal/version.GIT_SHA=foobars -X gitlab-master.nvidia.com/dgx/infra/skyhook-operator/internal/version.VERSION=v0.5.0'",
14+
"env": {
15+
"ENABLE_WEBHOOKS": "false",
16+
"LOG_ENCODER": "console",
17+
"LOG_LEVEL": "info",
18+
"REAPPLY_ON_REBOOT": "false",
19+
// "AGENT_IMAGE": "nvcr.io/nvidian/swgpu-baseos/skyhook-agent:25.01.02-233800-38d9732d",
20+
"AGENT_IMAGE": "nvcr.io/nvidian/swgpu-baseos/agentless-test:6.2.0", // this is the mock image, if you need to test for real, use the real image.
21+
// "COPY_DIR_ROOT": "/var/lib/google/skyhook"
22+
},
23+
"args": [],
24+
"showLog": true
25+
},
26+
{
27+
"name": "Test Current File",
28+
"type": "go",
29+
"request": "launch",
30+
"mode": "test",
31+
"program": "${file}",
32+
"env": {},
33+
"args": [],
34+
"showLog": true
35+
}
36+
]
37+
}

‎CONTRIBUTING.md‎

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
<!--
2+
SPDX-FileCopyrightText: Copyright (c) 2024 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
3+
SPDX-License-Identifier: Apache-2.0
4+
-->
5+
6+
# Contributing
7+
8+
Want to contribute to Skyhook?
9+
10+
The sign-off is a simple line at the end of the explanation for the patch. Your
11+
signature certifies that you wrote the patch or otherwise have the right to pass
12+
it on as an open-source patch. The rules are pretty simple: if you can certify
13+
the below (from [developercertificate.org](http://developercertificate.org/)):
14+
15+
```
16+
Developer Certificate of Origin
17+
Version 1.1
18+
19+
Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
20+
1 Letterman Drive
21+
Suite D4700
22+
San Francisco, CA, 94129
23+
24+
Everyone is permitted to copy and distribute verbatim copies of this
25+
license document, but changing it is not allowed.
26+
27+
Developer's Certificate of Origin 1.1
28+
29+
By making a contribution to this project, I certify that:
30+
31+
(a) The contribution was created in whole or in part by me and I
32+
have the right to submit it under the open source license
33+
indicated in the file; or
34+
35+
(b) The contribution is based upon previous work that, to the best
36+
of my knowledge, is covered under an appropriate open source
37+
license and I have the right under that license to submit that
38+
work with modifications, whether created in whole or in part
39+
by me, under the same open source license (unless I am
40+
permitted to submit under a different license), as indicated
41+
in the file; or
42+
43+
(c) The contribution was provided directly to me by some other
44+
person who certified (a), (b) or (c) and I have not modified
45+
it.
46+
47+
(d) I understand and agree that this project and the contribution
48+
are public and that a record of the contribution (including all
49+
personal information I submit with it, including my sign-off) is
50+
maintained indefinitely and may be redistributed consistent with
51+
this project or the open source license(s) involved.
52+
```
53+
54+
Then you just add a line to every git commit message:
55+
56+
Signed-off-by: Joe Smith <joe.smith@email.com>
57+
58+
Use your real name (sorry, no pseudonyms or anonymous contributions.)
59+
60+
If you set your `user.name` and `user.email` git configs, you can sign your
61+
commit automatically with `git commit -s`.

‎LICENSE‎

Lines changed: 202 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,202 @@
1+
2+
Apache License
3+
Version 2.0, January 2004
4+
http://www.apache.org/licenses/
5+
6+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7+
8+
1. Definitions.
9+
10+
"License" shall mean the terms and conditions for use, reproduction,
11+
and distribution as defined by Sections 1 through 9 of this document.
12+
13+
"Licensor" shall mean the copyright owner or entity authorized by
14+
the copyright owner that is granting the License.
15+
16+
"Legal Entity" shall mean the union of the acting entity and all
17+
other entities that control, are controlled by, or are under common
18+
control with that entity. For the purposes of this definition,
19+
"control" means (i) the power, direct or indirect, to cause the
20+
direction or management of such entity, whether by contract or
21+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
22+
outstanding shares, or (iii) beneficial ownership of such entity.
23+
24+
"You" (or "Your") shall mean an individual or Legal Entity
25+
exercising permissions granted by this License.
26+
27+
"Source" form shall mean the preferred form for making modifications,
28+
including but not limited to software source code, documentation
29+
source, and configuration files.
30+
31+
"Object" form shall mean any form resulting from mechanical
32+
transformation or translation of a Source form, including but
33+
not limited to compiled object code, generated documentation,
34+
and conversions to other media types.
35+
36+
"Work" shall mean the work of authorship, whether in Source or
37+
Object form, made available under the License, as indicated by a
38+
copyright notice that is included in or attached to the work
39+
(an example is provided in the Appendix below).
40+
41+
"Derivative Works" shall mean any work, whether in Source or Object
42+
form, that is based on (or derived from) the Work and for which the
43+
editorial revisions, annotations, elaborations, or other modifications
44+
represent, as a whole, an original work of authorship. For the purposes
45+
of this License, Derivative Works shall not include works that remain
46+
separable from, or merely link (or bind by name) to the interfaces of,
47+
the Work and Derivative Works thereof.
48+
49+
"Contribution" shall mean any work of authorship, including
50+
the original version of the Work and any modifications or additions
51+
to that Work or Derivative Works thereof, that is intentionally
52+
submitted to Licensor for inclusion in the Work by the copyright owner
53+
or by an individual or Legal Entity authorized to submit on behalf of
54+
the copyright owner. For the purposes of this definition, "submitted"
55+
means any form of electronic, verbal, or written communication sent
56+
to the Licensor or its representatives, including but not limited to
57+
communication on electronic mailing lists, source code control systems,
58+
and issue tracking systems that are managed by, or on behalf of, the
59+
Licensor for the purpose of discussing and improving the Work, but
60+
excluding communication that is conspicuously marked or otherwise
61+
designated in writing by the copyright owner as "Not a Contribution."
62+
63+
"Contributor" shall mean Licensor and any individual or Legal Entity
64+
on behalf of whom a Contribution has been received by Licensor and
65+
subsequently incorporated within the Work.
66+
67+
2. Grant of Copyright License. Subject to the terms and conditions of
68+
this License, each Contributor hereby grants to You a perpetual,
69+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70+
copyright license to reproduce, prepare Derivative Works of,
71+
publicly display, publicly perform, sublicense, and distribute the
72+
Work and such Derivative Works in Source or Object form.
73+
74+
3. Grant of Patent License. Subject to the terms and conditions of
75+
this License, each Contributor hereby grants to You a perpetual,
76+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77+
(except as stated in this section) patent license to make, have made,
78+
use, offer to sell, sell, import, and otherwise transfer the Work,
79+
where such license applies only to those patent claims licensable
80+
by such Contributor that are necessarily infringed by their
81+
Contribution(s) alone or by combination of their Contribution(s)
82+
with the Work to which such Contribution(s) was submitted. If You
83+
institute patent litigation against any entity (including a
84+
cross-claim or counterclaim in a lawsuit) alleging that the Work
85+
or a Contribution incorporated within the Work constitutes direct
86+
or contributory patent infringement, then any patent licenses
87+
granted to You under this License for that Work shall terminate
88+
as of the date such litigation is filed.
89+
90+
4. Redistribution. You may reproduce and distribute copies of the
91+
Work or Derivative Works thereof in any medium, with or without
92+
modifications, and in Source or Object form, provided that You
93+
meet the following conditions:
94+
95+
(a) You must give any other recipients of the Work or
96+
Derivative Works a copy of this License; and
97+
98+
(b) You must cause any modified files to carry prominent notices
99+
stating that You changed the files; and
100+
101+
(c) You must retain, in the Source form of any Derivative Works
102+
that You distribute, all copyright, patent, trademark, and
103+
attribution notices from the Source form of the Work,
104+
excluding those notices that do not pertain to any part of
105+
the Derivative Works; and
106+
107+
(d) If the Work includes a "NOTICE" text file as part of its
108+
distribution, then any Derivative Works that You distribute must
109+
include a readable copy of the attribution notices contained
110+
within such NOTICE file, excluding those notices that do not
111+
pertain to any part of the Derivative Works, in at least one
112+
of the following places: within a NOTICE text file distributed
113+
as part of the Derivative Works; within the Source form or
114+
documentation, if provided along with the Derivative Works; or,
115+
within a display generated by the Derivative Works, if and
116+
wherever such third-party notices normally appear. The contents
117+
of the NOTICE file are for informational purposes only and
118+
do not modify the License. You may add Your own attribution
119+
notices within Derivative Works that You distribute, alongside
120+
or as an addendum to the NOTICE text from the Work, provided
121+
that such additional attribution notices cannot be construed
122+
as modifying the License.
123+
124+
You may add Your own copyright statement to Your modifications and
125+
may provide additional or different license terms and conditions
126+
for use, reproduction, or distribution of Your modifications, or
127+
for any such Derivative Works as a whole, provided Your use,
128+
reproduction, and distribution of the Work otherwise complies with
129+
the conditions stated in this License.
130+
131+
5. Submission of Contributions. Unless You explicitly state otherwise,
132+
any Contribution intentionally submitted for inclusion in the Work
133+
by You to the Licensor shall be under the terms and conditions of
134+
this License, without any additional terms or conditions.
135+
Notwithstanding the above, nothing herein shall supersede or modify
136+
the terms of any separate license agreement you may have executed
137+
with Licensor regarding such Contributions.
138+
139+
6. Trademarks. This License does not grant permission to use the trade
140+
names, trademarks, service marks, or product names of the Licensor,
141+
except as required for reasonable and customary use in describing the
142+
origin of the Work and reproducing the content of the NOTICE file.
143+
144+
7. Disclaimer of Warranty. Unless required by applicable law or
145+
agreed to in writing, Licensor provides the Work (and each
146+
Contributor provides its Contributions) on an "AS IS" BASIS,
147+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148+
implied, including, without limitation, any warranties or conditions
149+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150+
PARTICULAR PURPOSE. You are solely responsible for determining the
151+
appropriateness of using or redistributing the Work and assume any
152+
risks associated with Your exercise of permissions under this License.
153+
154+
8. Limitation of Liability. In no event and under no legal theory,
155+
whether in tort (including negligence), contract, or otherwise,
156+
unless required by applicable law (such as deliberate and grossly
157+
negligent acts) or agreed to in writing, shall any Contributor be
158+
liable to You for damages, including any direct, indirect, special,
159+
incidental, or consequential damages of any character arising as a
160+
result of this License or out of the use or inability to use the
161+
Work (including but not limited to damages for loss of goodwill,
162+
work stoppage, computer failure or malfunction, or any and all
163+
other commercial damages or losses), even if such Contributor
164+
has been advised of the possibility of such damages.
165+
166+
9. Accepting Warranty or Additional Liability. While redistributing
167+
the Work or Derivative Works thereof, You may choose to offer,
168+
and charge a fee for, acceptance of support, warranty, indemnity,
169+
or other liability obligations and/or rights consistent with this
170+
License. However, in accepting such obligations, You may act only
171+
on Your own behalf and on Your sole responsibility, not on behalf
172+
of any other Contributor, and only if You agree to indemnify,
173+
defend, and hold each Contributor harmless for any liability
174+
incurred by, or claims asserted against, such Contributor by reason
175+
of your accepting any such warranty or additional liability.
176+
177+
END OF TERMS AND CONDITIONS
178+
179+
APPENDIX: How to apply the Apache License to your work.
180+
181+
To apply the Apache License to your work, attach the following
182+
boilerplate notice, with the fields enclosed by brackets "[]"
183+
replaced with your own identifying information. (Don't include
184+
the brackets!) The text should be enclosed in the appropriate
185+
comment syntax for the file format. We also recommend that a
186+
file or class name and description of purpose be included on the
187+
same "printed page" as the copyright notice for easier
188+
identification within third-party archives.
189+
190+
Copyright The Helm Authors.
191+
192+
Licensed under the Apache License, Version 2.0 (the "License");
193+
you may not use this file except in compliance with the License.
194+
You may obtain a copy of the License at
195+
196+
http://www.apache.org/licenses/LICENSE-2.0
197+
198+
Unless required by applicable law or agreed to in writing, software
199+
distributed under the License is distributed on an "AS IS" BASIS,
200+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201+
See the License for the specific language governing permissions and
202+
limitations under the License.

‎README.md‎

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
# skyhook
2+
3+
Skyhook was developed for modifying the underlying host OS in Kubernetes clusters. Think of it as a package manager like apt/yum for linux but for whole cluster management. The package manager (Skyhook Operator) manages the lifecycle (install/configure/uninstall/upgrade) of the packages (Skyhook Custom Resource, often SCR for short). It is Kubernetes aware, making cluster modifications easy. This enables Skyhook to schedule updates around important workloads and do rolling updates. It can be used in any cluster environment: self-managed clusters, on-prem clusters, cloud clusters, etc.
4+
5+
## Benefits
6+
- The requested changes (the Packages) are native Kubernetes resources they can be combined and applied with common tools like ArgoCD, Helm, Flux etc. This means that all the tooling to manage applications can package customizations right alongside them to get applied, removed and upgraded as the applications themselves are.
7+
- Autoscaling, with skyhook if you want to enable autoscaling on your cluster but need to modify all Nodes added to a cluster, you need something that is kubernetes aware. Skyhook as feature to make sure you nodes are ready before then enter the cluster.
8+
- Upgrades are first class, with skyhook you can make deploy changes to your cluster and can wait for running workloads to finish before applying changes.
9+
10+
## Key Features
11+
- **interruptionBudget:** percent of nodes or count
12+
- **nodeSelectors:** selectors for which nodes to apply too (node labels)
13+
- **podNonInterruptLabels:** labels for pods to **never** interrupt
14+
- **package interrupt:** service (containerd, cron, any thing systemd), or reboot
15+
- **config interrupt:** service, or reboot when a certain key's value changes in the configmap
16+
- **configMap:** per package
17+
- **env vars:** per package
18+
- **additionalTolerations:** are tolerations added to the packages
19+
- [**runtimeRequired**](docs/runtime_required.md): requires node to come into the cluster with a taint, and will do work prior to removing custom taint.
20+
21+
### Stages
22+
The operator will apply steps in a package throughout different lifecycle stages. This ensures that the right steps are applied in the right situations and in the correct order.
23+
- Upgrade: This stage will be ran whenever a package's version is upgraded in the SCR.
24+
- Uninstall: This stage will be ran whenever a package's version is downgraded or it's removed from the SCR.
25+
- Apply: This stage will always be ran at least once.
26+
- Config: This stage will run when a configmap is changed and on the first SCR application.
27+
- Interrupt: This stage will run when a package has an interrupt defined or a key's value in a packages configmap changes which has a config interrupt defined.
28+
- Post-Interrupt: This stage will run when a package's interrupt has finished.
29+
30+
The stages are applied in this order:
31+
32+
- Uninstall -> Apply -> Config -> Interrupt -> Post-Interrupt (No Upgrade)
33+
- Upgrade -> Config -> Interrupt -> Post-Interrupt (With Upgrade)
34+
35+
**Semantic versioning is strictly enforced in the operator** in order to support upgrade and uninstall. Semantic versioning allows the
36+
operator to know which way the package is going while also enforcing best versioning practices.
37+
38+
***NOTE:*** The stages that are actually applied can change depending on the configuration of the package and current state. See [Skyhook 2.0](https://docs.google.com/document/d/1rnU0fs4MoWi9NfD2ff1hZMWRJKNQ58HeKob34EjS92M/) for more info.
39+
40+
## Packages
41+
Part of how the operator works is the [skyhook-agent](agent/README.md). Packages have to be created in way so the operator knows how to use them. This is where the agent comes into play, more on that later. A package is a container that meets these requirements:
42+
43+
- Container shall have `bash`, so needs to be at least something like busybox/alpine
44+
- Config that is valid, jsonschema is used to valid this config. The agent has a tool build in to valid the config. This tool should be used to test packages before publishing.
45+
- The file system structure needs to adhere to:
46+
```
47+
/skyhook-package
48+
├── skyhook_dir/{steps}
49+
├── root_dir/{static files}
50+
└── config.json
51+
```
52+
53+
## [Skyhook-Operator](operator/README.md)
54+
The operator is a kbuernetes operator that monitors cluster events and coordinates the installation and lifecycle of Skyhook packages.
55+
56+
## [Skyhook Agent](agent/README.md)
57+
The agent is what does the operators work and is a separate container from the package. The agent knowns how to read a package (/skyhook_package/config.json) is what implements the [lifecycle](#stages) packages go though.
58+

‎agent/.gitignore‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
venv
2+
root_mount
3+
root
4+
5+
__pycache__
6+
.pytest_cache
7+
dist
8+
.coverage
9+
.coverage.*
10+
coverage.xml
11+
12+
vendor/lock_file.bak

0 commit comments

Comments
 (0)