pepr 0.21.1 → 0.22.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +13 -3
- package/codecov.yaml +19 -0
- package/dist/cli.js +118 -46
- package/dist/controller.js +1 -1
- package/dist/lib/assets/deploy.d.ts +1 -1
- package/dist/lib/assets/deploy.d.ts.map +1 -1
- package/dist/lib/assets/index.d.ts +1 -1
- package/dist/lib/assets/index.d.ts.map +1 -1
- package/dist/lib/assets/pods.d.ts +18 -0
- package/dist/lib/assets/pods.d.ts.map +1 -1
- package/dist/lib/helpers.d.ts +2 -0
- package/dist/lib/helpers.d.ts.map +1 -1
- package/package.json +10 -8
- package/src/lib/assets/deploy.ts +22 -22
- package/src/lib/assets/index.ts +2 -2
- package/src/lib/assets/pods.ts +36 -0
- package/src/lib/helpers.ts +42 -0
- package/website/.linkinator.config.json +0 -8
- package/website/.markdownlint.json +0 -6
- package/website/.prettierignore +0 -12
- package/website/LICENSE +0 -201
- package/website/README.md +0 -50
- package/website/archetypes/default.md +0 -6
- package/website/assets/img/Pepr.Horizontal.white.svg +0 -144
- package/website/assets/img/doug.svg +0 -345
- package/website/assets/img/pepr.svg +0 -212
- package/website/assets/scss/_styles_project.scss +0 -7
- package/website/assets/scss/_variables_project.scss +0 -1
- package/website/content/en/docs/OnSchedule.md +0 -86
- package/website/content/en/docs/_index.md +0 -9
- package/website/content/en/docs/cli.md +0 -83
- package/website/content/en/docs/codeSample.txt +0 -31
- package/website/content/en/docs/concepts.md +0 -238
- package/website/content/en/docs/customresources.md +0 -167
- package/website/content/en/docs/diagrams.txt +0 -18
- package/website/content/en/docs/metrics.md +0 -113
- package/website/content/en/docs/rbac.md +0 -153
- package/website/content/en/docs/store.md +0 -48
- package/website/content/en/docs/webassembly.md +0 -189
- package/website/go.mod +0 -8
- package/website/go.sum +0 -4
- package/website/package-lock.json +0 -3907
- package/website/package.json +0 -30
- package/website/renovate.json +0 -16
- package/website/static/favicons/android-144x144.png +0 -0
- package/website/static/favicons/android-192x192.png +0 -0
- package/website/static/favicons/android-36x36.png +0 -0
- package/website/static/favicons/android-48x48.png +0 -0
- package/website/static/favicons/android-72x72.png +0 -0
- package/website/static/favicons/android-96x96.png +0 -0
- package/website/static/favicons/android-chrome-192x192.png +0 -0
- package/website/static/favicons/android-chrome-512x512.png +0 -0
- package/website/static/favicons/android-chrome-maskable-192x192.png +0 -0
- package/website/static/favicons/android-chrome-maskable-512x512.png +0 -0
- package/website/static/favicons/apple-touch-icon-180x180.png +0 -0
- package/website/static/favicons/apple-touch-icon.png +0 -0
- package/website/static/favicons/favicon-16x16.png +0 -0
- package/website/static/favicons/favicon-32x32.png +0 -0
- package/website/static/favicons/favicon.ico +0 -0
- package/website/static/img/how-to-use.png +0 -0
package/package.json
CHANGED
|
@@ -9,7 +9,7 @@
|
|
|
9
9
|
"engines": {
|
|
10
10
|
"node": ">=18.0.0"
|
|
11
11
|
},
|
|
12
|
-
"version": "0.
|
|
12
|
+
"version": "0.22.1",
|
|
13
13
|
"main": "dist/lib.js",
|
|
14
14
|
"types": "dist/lib.d.ts",
|
|
15
15
|
"scripts": {
|
|
@@ -17,14 +17,16 @@
|
|
|
17
17
|
"prebuild": "rm -fr dist/* && npm run gen-data-json",
|
|
18
18
|
"build": "tsc && node build.mjs",
|
|
19
19
|
"test": "npm run test:unit && npm run test:journey",
|
|
20
|
-
"test:unit": "npm run gen-data-json && jest src --coverage --detectOpenHandles",
|
|
20
|
+
"test:unit": "npm run gen-data-json && jest src --coverage --detectOpenHandles --coverageDirectory=./coverage",
|
|
21
21
|
"test:journey": "npm run test:journey:k3d && npm run test:journey:build && npm run test:journey:image && npm run test:journey:run",
|
|
22
|
+
"test:journey:prep": "git clone https://github.com/defenseunicorns/pepr-upgrade-test.git",
|
|
22
23
|
"test:journey-wasm": "npm run test:journey:k3d && npm run test:journey:build && npm run test:journey:image && npm run test:journey:run-wasm",
|
|
23
24
|
"test:journey:k3d": "k3d cluster delete pepr-dev && k3d cluster create pepr-dev --k3s-arg '--debug@server:0' --wait && kubectl rollout status deployment -n kube-system",
|
|
24
25
|
"test:journey:build": "npm run build && npm pack",
|
|
25
26
|
"test:journey:image": "docker buildx build --tag pepr:dev . && k3d image import pepr:dev -c pepr-dev",
|
|
26
|
-
"test:journey:run": "jest --detectOpenHandles journey/entrypoint.test.ts",
|
|
27
|
+
"test:journey:run": "jest --detectOpenHandles journey/entrypoint.test.ts && npm run test:journey:prep && npm run test:journey:upgrade",
|
|
27
28
|
"test:journey:run-wasm": "jest --detectOpenHandles journey/entrypoint-wasm.test.ts",
|
|
29
|
+
"test:journey:upgrade": "npm run test:journey:k3d && npm run test:journey:image && jest --detectOpenHandles journey/pepr-upgrade.test.ts",
|
|
28
30
|
"format:check": "eslint src && prettier src --check",
|
|
29
31
|
"format:fix": "eslint src --fix && prettier src --write"
|
|
30
32
|
},
|
|
@@ -39,17 +41,17 @@
|
|
|
39
41
|
"ramda": "0.29.1"
|
|
40
42
|
},
|
|
41
43
|
"devDependencies": {
|
|
42
|
-
"@commitlint/cli": "18.4.
|
|
43
|
-
"@commitlint/config-conventional": "18.4.
|
|
44
|
+
"@commitlint/cli": "18.4.4",
|
|
45
|
+
"@commitlint/config-conventional": "18.4.4",
|
|
44
46
|
"@jest/globals": "29.7.0",
|
|
45
|
-
"@types/eslint": "8.56.
|
|
47
|
+
"@types/eslint": "8.56.2",
|
|
46
48
|
"@types/express": "4.17.21",
|
|
47
49
|
"@types/node": "18.x.x",
|
|
48
|
-
"@types/node-forge": "1.3.
|
|
50
|
+
"@types/node-forge": "1.3.11",
|
|
49
51
|
"@types/prompts": "2.4.9",
|
|
50
52
|
"@types/uuid": "9.0.7",
|
|
51
53
|
"jest": "29.7.0",
|
|
52
|
-
"nock": "13.
|
|
54
|
+
"nock": "13.5.0",
|
|
53
55
|
"ts-jest": "29.1.1"
|
|
54
56
|
},
|
|
55
57
|
"peerDependencies": {
|
package/src/lib/assets/deploy.ts
CHANGED
|
@@ -14,7 +14,7 @@ import { peprStoreCRD } from "./store";
|
|
|
14
14
|
import { webhookConfig } from "./webhooks";
|
|
15
15
|
import { CapabilityExport } from "../types";
|
|
16
16
|
|
|
17
|
-
export async function deploy(assets: Assets, webhookTimeout?: number) {
|
|
17
|
+
export async function deploy(assets: Assets, force: boolean, webhookTimeout?: number) {
|
|
18
18
|
Log.info("Establishing connection to Kubernetes");
|
|
19
19
|
|
|
20
20
|
const { name, host, path } = assets;
|
|
@@ -26,7 +26,7 @@ export async function deploy(assets: Assets, webhookTimeout?: number) {
|
|
|
26
26
|
const mutateWebhook = await webhookConfig(assets, "mutate", webhookTimeout);
|
|
27
27
|
if (mutateWebhook) {
|
|
28
28
|
Log.info("Applying mutating webhook");
|
|
29
|
-
await K8s(kind.MutatingWebhookConfiguration).Apply(mutateWebhook);
|
|
29
|
+
await K8s(kind.MutatingWebhookConfiguration).Apply(mutateWebhook, { force });
|
|
30
30
|
} else {
|
|
31
31
|
Log.info("Mutating webhook not needed, removing if it exists");
|
|
32
32
|
await K8s(kind.MutatingWebhookConfiguration).Delete(name);
|
|
@@ -36,14 +36,14 @@ export async function deploy(assets: Assets, webhookTimeout?: number) {
|
|
|
36
36
|
const validateWebhook = await webhookConfig(assets, "validate", webhookTimeout);
|
|
37
37
|
if (validateWebhook) {
|
|
38
38
|
Log.info("Applying validating webhook");
|
|
39
|
-
await K8s(kind.ValidatingWebhookConfiguration).Apply(validateWebhook);
|
|
39
|
+
await K8s(kind.ValidatingWebhookConfiguration).Apply(validateWebhook, { force });
|
|
40
40
|
} else {
|
|
41
41
|
Log.info("Validating webhook not needed, removing if it exists");
|
|
42
42
|
await K8s(kind.ValidatingWebhookConfiguration).Delete(name);
|
|
43
43
|
}
|
|
44
44
|
|
|
45
45
|
Log.info("Applying the Pepr Store CRD if it doesn't exist");
|
|
46
|
-
await K8s(kind.CustomResourceDefinition).Apply(peprStoreCRD);
|
|
46
|
+
await K8s(kind.CustomResourceDefinition).Apply(peprStoreCRD, { force });
|
|
47
47
|
|
|
48
48
|
// If a host is specified, we don't need to deploy the rest of the resources
|
|
49
49
|
if (host) {
|
|
@@ -57,66 +57,66 @@ export async function deploy(assets: Assets, webhookTimeout?: number) {
|
|
|
57
57
|
throw new Error("No code provided");
|
|
58
58
|
}
|
|
59
59
|
|
|
60
|
-
await setupRBAC(name, assets.capabilities);
|
|
61
|
-
await setupController(assets, code, hash);
|
|
62
|
-
await setupWatcher(assets, hash);
|
|
60
|
+
await setupRBAC(name, assets.capabilities, force);
|
|
61
|
+
await setupController(assets, code, hash, force);
|
|
62
|
+
await setupWatcher(assets, hash, force);
|
|
63
63
|
}
|
|
64
64
|
|
|
65
|
-
async function setupRBAC(name: string, capabilities: CapabilityExport[]) {
|
|
65
|
+
async function setupRBAC(name: string, capabilities: CapabilityExport[], force: boolean) {
|
|
66
66
|
Log.info("Applying cluster role binding");
|
|
67
67
|
const crb = clusterRoleBinding(name);
|
|
68
|
-
await K8s(kind.ClusterRoleBinding).Apply(crb);
|
|
68
|
+
await K8s(kind.ClusterRoleBinding).Apply(crb, { force });
|
|
69
69
|
|
|
70
70
|
Log.info("Applying cluster role");
|
|
71
71
|
const cr = clusterRole(name, capabilities);
|
|
72
|
-
await K8s(kind.ClusterRole).Apply(cr);
|
|
72
|
+
await K8s(kind.ClusterRole).Apply(cr, { force });
|
|
73
73
|
|
|
74
74
|
Log.info("Applying service account");
|
|
75
75
|
const sa = serviceAccount(name);
|
|
76
|
-
await K8s(kind.ServiceAccount).Apply(sa);
|
|
76
|
+
await K8s(kind.ServiceAccount).Apply(sa, { force });
|
|
77
77
|
|
|
78
78
|
Log.info("Applying store role");
|
|
79
79
|
const role = storeRole(name);
|
|
80
|
-
await K8s(kind.Role).Apply(role);
|
|
80
|
+
await K8s(kind.Role).Apply(role, { force });
|
|
81
81
|
|
|
82
82
|
Log.info("Applying store role binding");
|
|
83
83
|
const roleBinding = storeRoleBinding(name);
|
|
84
|
-
await K8s(kind.RoleBinding).Apply(roleBinding);
|
|
84
|
+
await K8s(kind.RoleBinding).Apply(roleBinding, { force });
|
|
85
85
|
}
|
|
86
86
|
|
|
87
|
-
async function setupController(assets: Assets, code: Buffer, hash: string) {
|
|
87
|
+
async function setupController(assets: Assets, code: Buffer, hash: string, force: boolean) {
|
|
88
88
|
const { name } = assets;
|
|
89
89
|
|
|
90
90
|
Log.info("Applying module secret");
|
|
91
91
|
const mod = moduleSecret(name, code, hash);
|
|
92
|
-
await K8s(kind.Secret).Apply(mod);
|
|
92
|
+
await K8s(kind.Secret).Apply(mod, { force });
|
|
93
93
|
|
|
94
94
|
Log.info("Applying controller service");
|
|
95
95
|
const svc = service(name);
|
|
96
|
-
await K8s(kind.Service).Apply(svc);
|
|
96
|
+
await K8s(kind.Service).Apply(svc, { force });
|
|
97
97
|
|
|
98
98
|
Log.info("Applying TLS secret");
|
|
99
99
|
const tls = tlsSecret(name, assets.tls);
|
|
100
|
-
await K8s(kind.Secret).Apply(tls);
|
|
100
|
+
await K8s(kind.Secret).Apply(tls, { force });
|
|
101
101
|
|
|
102
102
|
Log.info("Applying API token secret");
|
|
103
103
|
const apiToken = apiTokenSecret(name, assets.apiToken);
|
|
104
|
-
await K8s(kind.Secret).Apply(apiToken);
|
|
104
|
+
await K8s(kind.Secret).Apply(apiToken, { force });
|
|
105
105
|
|
|
106
106
|
Log.info("Applying deployment");
|
|
107
107
|
const dep = deployment(assets, hash);
|
|
108
|
-
await K8s(kind.Deployment).Apply(dep);
|
|
108
|
+
await K8s(kind.Deployment).Apply(dep, { force });
|
|
109
109
|
}
|
|
110
110
|
|
|
111
|
-
async function setupWatcher(assets: Assets, hash: string) {
|
|
111
|
+
async function setupWatcher(assets: Assets, hash: string, force: boolean) {
|
|
112
112
|
// If the module has a watcher, deploy it
|
|
113
113
|
const watchDeployment = watcher(assets, hash);
|
|
114
114
|
if (watchDeployment) {
|
|
115
115
|
Log.info("Applying watcher deployment");
|
|
116
|
-
await K8s(kind.Deployment).Apply(watchDeployment);
|
|
116
|
+
await K8s(kind.Deployment).Apply(watchDeployment, { force });
|
|
117
117
|
|
|
118
118
|
Log.info("Applying watcher service");
|
|
119
119
|
const watchSvc = watcherService(assets.name);
|
|
120
|
-
await K8s(kind.Service).Apply(watchSvc);
|
|
120
|
+
await K8s(kind.Service).Apply(watchSvc, { force });
|
|
121
121
|
}
|
|
122
122
|
}
|
package/src/lib/assets/index.ts
CHANGED
|
@@ -37,9 +37,9 @@ export class Assets {
|
|
|
37
37
|
this.apiToken = crypto.randomBytes(32).toString("hex");
|
|
38
38
|
}
|
|
39
39
|
|
|
40
|
-
deploy = async (webhookTimeout?: number) => {
|
|
40
|
+
deploy = async (force: boolean, webhookTimeout?: number) => {
|
|
41
41
|
this.capabilities = await loadCapabilities(this.path);
|
|
42
|
-
await deploy(this, webhookTimeout);
|
|
42
|
+
await deploy(this, force, webhookTimeout);
|
|
43
43
|
};
|
|
44
44
|
|
|
45
45
|
zarfYaml = (path: string) => zarfYaml(this, path);
|
package/src/lib/assets/pods.ts
CHANGED
|
@@ -63,6 +63,9 @@ export function watcher(assets: Assets, hash: string) {
|
|
|
63
63
|
},
|
|
64
64
|
template: {
|
|
65
65
|
metadata: {
|
|
66
|
+
annotations: {
|
|
67
|
+
buildTimestamp: `${Date.now()}`,
|
|
68
|
+
},
|
|
66
69
|
labels: {
|
|
67
70
|
app,
|
|
68
71
|
"pepr.dev/controller": "watcher",
|
|
@@ -70,6 +73,12 @@ export function watcher(assets: Assets, hash: string) {
|
|
|
70
73
|
},
|
|
71
74
|
spec: {
|
|
72
75
|
serviceAccountName: name,
|
|
76
|
+
securityContext: {
|
|
77
|
+
runAsUser: 65532,
|
|
78
|
+
runAsGroup: 65532,
|
|
79
|
+
runAsNonRoot: true,
|
|
80
|
+
fsGroup: 65532,
|
|
81
|
+
},
|
|
73
82
|
containers: [
|
|
74
83
|
{
|
|
75
84
|
name: "watcher",
|
|
@@ -105,6 +114,15 @@ export function watcher(assets: Assets, hash: string) {
|
|
|
105
114
|
cpu: "500m",
|
|
106
115
|
},
|
|
107
116
|
},
|
|
117
|
+
securityContext: {
|
|
118
|
+
runAsUser: 65532,
|
|
119
|
+
runAsGroup: 65532,
|
|
120
|
+
runAsNonRoot: true,
|
|
121
|
+
allowPrivilegeEscalation: false,
|
|
122
|
+
capabilities: {
|
|
123
|
+
drop: ["ALL"],
|
|
124
|
+
},
|
|
125
|
+
},
|
|
108
126
|
volumeMounts: [
|
|
109
127
|
{
|
|
110
128
|
name: "tls-certs",
|
|
@@ -165,6 +183,9 @@ export function deployment(assets: Assets, hash: string): kind.Deployment {
|
|
|
165
183
|
},
|
|
166
184
|
template: {
|
|
167
185
|
metadata: {
|
|
186
|
+
annotations: {
|
|
187
|
+
buildTimestamp: `${Date.now()}`,
|
|
188
|
+
},
|
|
168
189
|
labels: {
|
|
169
190
|
app,
|
|
170
191
|
"pepr.dev/controller": "admission",
|
|
@@ -173,6 +194,12 @@ export function deployment(assets: Assets, hash: string): kind.Deployment {
|
|
|
173
194
|
spec: {
|
|
174
195
|
priorityClassName: "system-node-critical",
|
|
175
196
|
serviceAccountName: name,
|
|
197
|
+
securityContext: {
|
|
198
|
+
runAsUser: 65532,
|
|
199
|
+
runAsGroup: 65532,
|
|
200
|
+
runAsNonRoot: true,
|
|
201
|
+
fsGroup: 65532,
|
|
202
|
+
},
|
|
176
203
|
containers: [
|
|
177
204
|
{
|
|
178
205
|
name: "server",
|
|
@@ -209,6 +236,15 @@ export function deployment(assets: Assets, hash: string): kind.Deployment {
|
|
|
209
236
|
},
|
|
210
237
|
},
|
|
211
238
|
env: genEnv(config),
|
|
239
|
+
securityContext: {
|
|
240
|
+
runAsUser: 65532,
|
|
241
|
+
runAsGroup: 65532,
|
|
242
|
+
runAsNonRoot: true,
|
|
243
|
+
allowPrivilegeEscalation: false,
|
|
244
|
+
capabilities: {
|
|
245
|
+
drop: ["ALL"],
|
|
246
|
+
},
|
|
247
|
+
},
|
|
212
248
|
volumeMounts: [
|
|
213
249
|
{
|
|
214
250
|
name: "tls-certs",
|
package/src/lib/helpers.ts
CHANGED
|
@@ -1,6 +1,8 @@
|
|
|
1
1
|
// SPDX-License-Identifier: Apache-2.0
|
|
2
2
|
// SPDX-FileCopyrightText: 2023-Present The Pepr Authors
|
|
3
3
|
|
|
4
|
+
import { K8s, kind } from "kubernetes-fluent-client";
|
|
5
|
+
import Log from "./logger";
|
|
4
6
|
import { CapabilityExport } from "./types";
|
|
5
7
|
import { promises as fs } from "fs";
|
|
6
8
|
|
|
@@ -119,3 +121,43 @@ export function namespaceComplianceValidator(capability: CapabilityExport, ignor
|
|
|
119
121
|
);
|
|
120
122
|
}
|
|
121
123
|
}
|
|
124
|
+
|
|
125
|
+
// check to see if all replicas are ready for all deployments in the pepr-system namespace
|
|
126
|
+
// returns true if all deployments are ready, false otherwise
|
|
127
|
+
export async function checkDeploymentStatus(namespace: string) {
|
|
128
|
+
const deployments = await K8s(kind.Deployment).InNamespace(namespace).Get();
|
|
129
|
+
let status = false;
|
|
130
|
+
let readyCount = 0;
|
|
131
|
+
|
|
132
|
+
for (const deployment of deployments.items) {
|
|
133
|
+
const readyReplicas = deployment.status?.readyReplicas ? deployment.status?.readyReplicas : 0;
|
|
134
|
+
if (deployment.status?.readyReplicas !== deployment.spec?.replicas) {
|
|
135
|
+
Log.info(
|
|
136
|
+
`Waiting for deployment ${deployment.metadata?.name} rollout to finish: ${readyReplicas} of ${deployment.spec?.replicas} replicas are available`,
|
|
137
|
+
);
|
|
138
|
+
} else {
|
|
139
|
+
Log.info(
|
|
140
|
+
`Deployment ${deployment.metadata?.name} rolled out: ${readyReplicas} of ${deployment.spec?.replicas} replicas are available`,
|
|
141
|
+
);
|
|
142
|
+
readyCount++;
|
|
143
|
+
}
|
|
144
|
+
}
|
|
145
|
+
if (readyCount === deployments.items.length) {
|
|
146
|
+
status = true;
|
|
147
|
+
}
|
|
148
|
+
return status;
|
|
149
|
+
}
|
|
150
|
+
|
|
151
|
+
// wait for all deployments in the pepr-system namespace to be ready
|
|
152
|
+
export async function namespaceDeploymentsReady(namespace: string = "pepr-system") {
|
|
153
|
+
Log.info(`Checking ${namespace} deployments status...`);
|
|
154
|
+
let ready = false;
|
|
155
|
+
while (!ready) {
|
|
156
|
+
ready = await checkDeploymentStatus(namespace);
|
|
157
|
+
if (ready) {
|
|
158
|
+
return ready;
|
|
159
|
+
}
|
|
160
|
+
await new Promise(resolve => setTimeout(resolve, 1000));
|
|
161
|
+
}
|
|
162
|
+
Log.info(`All ${namespace} deployments are ready`);
|
|
163
|
+
}
|
package/website/.prettierignore
DELETED
package/website/LICENSE
DELETED
|
@@ -1,201 +0,0 @@
|
|
|
1
|
-
Apache License
|
|
2
|
-
Version 2.0, January 2004
|
|
3
|
-
http://www.apache.org/licenses/
|
|
4
|
-
|
|
5
|
-
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
6
|
-
|
|
7
|
-
1. Definitions.
|
|
8
|
-
|
|
9
|
-
"License" shall mean the terms and conditions for use, reproduction,
|
|
10
|
-
and distribution as defined by Sections 1 through 9 of this document.
|
|
11
|
-
|
|
12
|
-
"Licensor" shall mean the copyright owner or entity authorized by
|
|
13
|
-
the copyright owner that is granting the License.
|
|
14
|
-
|
|
15
|
-
"Legal Entity" shall mean the union of the acting entity and all
|
|
16
|
-
other entities that control, are controlled by, or are under common
|
|
17
|
-
control with that entity. For the purposes of this definition,
|
|
18
|
-
"control" means (i) the power, direct or indirect, to cause the
|
|
19
|
-
direction or management of such entity, whether by contract or
|
|
20
|
-
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
21
|
-
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
22
|
-
|
|
23
|
-
"You" (or "Your") shall mean an individual or Legal Entity
|
|
24
|
-
exercising permissions granted by this License.
|
|
25
|
-
|
|
26
|
-
"Source" form shall mean the preferred form for making modifications,
|
|
27
|
-
including but not limited to software source code, documentation
|
|
28
|
-
source, and configuration files.
|
|
29
|
-
|
|
30
|
-
"Object" form shall mean any form resulting from mechanical
|
|
31
|
-
transformation or translation of a Source form, including but
|
|
32
|
-
not limited to compiled object code, generated documentation,
|
|
33
|
-
and conversions to other media types.
|
|
34
|
-
|
|
35
|
-
"Work" shall mean the work of authorship, whether in Source or
|
|
36
|
-
Object form, made available under the License, as indicated by a
|
|
37
|
-
copyright notice that is included in or attached to the work
|
|
38
|
-
(an example is provided in the Appendix below).
|
|
39
|
-
|
|
40
|
-
"Derivative Works" shall mean any work, whether in Source or Object
|
|
41
|
-
form, that is based on (or derived from) the Work and for which the
|
|
42
|
-
editorial revisions, annotations, elaborations, or other modifications
|
|
43
|
-
represent, as a whole, an original work of authorship. For the purposes
|
|
44
|
-
of this License, Derivative Works shall not include works that remain
|
|
45
|
-
separable from, or merely link (or bind by name) to the interfaces of,
|
|
46
|
-
the Work and Derivative Works thereof.
|
|
47
|
-
|
|
48
|
-
"Contribution" shall mean any work of authorship, including
|
|
49
|
-
the original version of the Work and any modifications or additions
|
|
50
|
-
to that Work or Derivative Works thereof, that is intentionally
|
|
51
|
-
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
52
|
-
or by an individual or Legal Entity authorized to submit on behalf of
|
|
53
|
-
the copyright owner. For the purposes of this definition, "submitted"
|
|
54
|
-
means any form of electronic, verbal, or written communication sent
|
|
55
|
-
to the Licensor or its representatives, including but not limited to
|
|
56
|
-
communication on electronic mailing lists, source code control systems,
|
|
57
|
-
and issue tracking systems that are managed by, or on behalf of, the
|
|
58
|
-
Licensor for the purpose of discussing and improving the Work, but
|
|
59
|
-
excluding communication that is conspicuously marked or otherwise
|
|
60
|
-
designated in writing by the copyright owner as "Not a Contribution."
|
|
61
|
-
|
|
62
|
-
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
63
|
-
on behalf of whom a Contribution has been received by Licensor and
|
|
64
|
-
subsequently incorporated within the Work.
|
|
65
|
-
|
|
66
|
-
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
67
|
-
this License, each Contributor hereby grants to You a perpetual,
|
|
68
|
-
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
69
|
-
copyright license to reproduce, prepare Derivative Works of,
|
|
70
|
-
publicly display, publicly perform, sublicense, and distribute the
|
|
71
|
-
Work and such Derivative Works in Source or Object form.
|
|
72
|
-
|
|
73
|
-
3. Grant of Patent License. Subject to the terms and conditions of
|
|
74
|
-
this License, each Contributor hereby grants to You a perpetual,
|
|
75
|
-
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
76
|
-
(except as stated in this section) patent license to make, have made,
|
|
77
|
-
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
78
|
-
where such license applies only to those patent claims licensable
|
|
79
|
-
by such Contributor that are necessarily infringed by their
|
|
80
|
-
Contribution(s) alone or by combination of their Contribution(s)
|
|
81
|
-
with the Work to which such Contribution(s) was submitted. If You
|
|
82
|
-
institute patent litigation against any entity (including a
|
|
83
|
-
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
84
|
-
or a Contribution incorporated within the Work constitutes direct
|
|
85
|
-
or contributory patent infringement, then any patent licenses
|
|
86
|
-
granted to You under this License for that Work shall terminate
|
|
87
|
-
as of the date such litigation is filed.
|
|
88
|
-
|
|
89
|
-
4. Redistribution. You may reproduce and distribute copies of the
|
|
90
|
-
Work or Derivative Works thereof in any medium, with or without
|
|
91
|
-
modifications, and in Source or Object form, provided that You
|
|
92
|
-
meet the following conditions:
|
|
93
|
-
|
|
94
|
-
(a) You must give any other recipients of the Work or
|
|
95
|
-
Derivative Works a copy of this License; and
|
|
96
|
-
|
|
97
|
-
(b) You must cause any modified files to carry prominent notices
|
|
98
|
-
stating that You changed the files; and
|
|
99
|
-
|
|
100
|
-
(c) You must retain, in the Source form of any Derivative Works
|
|
101
|
-
that You distribute, all copyright, patent, trademark, and
|
|
102
|
-
attribution notices from the Source form of the Work,
|
|
103
|
-
excluding those notices that do not pertain to any part of
|
|
104
|
-
the Derivative Works; and
|
|
105
|
-
|
|
106
|
-
(d) If the Work includes a "NOTICE" text file as part of its
|
|
107
|
-
distribution, then any Derivative Works that You distribute must
|
|
108
|
-
include a readable copy of the attribution notices contained
|
|
109
|
-
within such NOTICE file, excluding those notices that do not
|
|
110
|
-
pertain to any part of the Derivative Works, in at least one
|
|
111
|
-
of the following places: within a NOTICE text file distributed
|
|
112
|
-
as part of the Derivative Works; within the Source form or
|
|
113
|
-
documentation, if provided along with the Derivative Works; or,
|
|
114
|
-
within a display generated by the Derivative Works, if and
|
|
115
|
-
wherever such third-party notices normally appear. The contents
|
|
116
|
-
of the NOTICE file are for informational purposes only and
|
|
117
|
-
do not modify the License. You may add Your own attribution
|
|
118
|
-
notices within Derivative Works that You distribute, alongside
|
|
119
|
-
or as an addendum to the NOTICE text from the Work, provided
|
|
120
|
-
that such additional attribution notices cannot be construed
|
|
121
|
-
as modifying the License.
|
|
122
|
-
|
|
123
|
-
You may add Your own copyright statement to Your modifications and
|
|
124
|
-
may provide additional or different license terms and conditions
|
|
125
|
-
for use, reproduction, or distribution of Your modifications, or
|
|
126
|
-
for any such Derivative Works as a whole, provided Your use,
|
|
127
|
-
reproduction, and distribution of the Work otherwise complies with
|
|
128
|
-
the conditions stated in this License.
|
|
129
|
-
|
|
130
|
-
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
131
|
-
any Contribution intentionally submitted for inclusion in the Work
|
|
132
|
-
by You to the Licensor shall be under the terms and conditions of
|
|
133
|
-
this License, without any additional terms or conditions.
|
|
134
|
-
Notwithstanding the above, nothing herein shall supersede or modify
|
|
135
|
-
the terms of any separate license agreement you may have executed
|
|
136
|
-
with Licensor regarding such Contributions.
|
|
137
|
-
|
|
138
|
-
6. Trademarks. This License does not grant permission to use the trade
|
|
139
|
-
names, trademarks, service marks, or product names of the Licensor,
|
|
140
|
-
except as required for reasonable and customary use in describing the
|
|
141
|
-
origin of the Work and reproducing the content of the NOTICE file.
|
|
142
|
-
|
|
143
|
-
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
144
|
-
agreed to in writing, Licensor provides the Work (and each
|
|
145
|
-
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
146
|
-
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
147
|
-
implied, including, without limitation, any warranties or conditions
|
|
148
|
-
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
149
|
-
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
150
|
-
appropriateness of using or redistributing the Work and assume any
|
|
151
|
-
risks associated with Your exercise of permissions under this License.
|
|
152
|
-
|
|
153
|
-
8. Limitation of Liability. In no event and under no legal theory,
|
|
154
|
-
whether in tort (including negligence), contract, or otherwise,
|
|
155
|
-
unless required by applicable law (such as deliberate and grossly
|
|
156
|
-
negligent acts) or agreed to in writing, shall any Contributor be
|
|
157
|
-
liable to You for damages, including any direct, indirect, special,
|
|
158
|
-
incidental, or consequential damages of any character arising as a
|
|
159
|
-
result of this License or out of the use or inability to use the
|
|
160
|
-
Work (including but not limited to damages for loss of goodwill,
|
|
161
|
-
work stoppage, computer failure or malfunction, or any and all
|
|
162
|
-
other commercial damages or losses), even if such Contributor
|
|
163
|
-
has been advised of the possibility of such damages.
|
|
164
|
-
|
|
165
|
-
9. Accepting Warranty or Additional Liability. While redistributing
|
|
166
|
-
the Work or Derivative Works thereof, You may choose to offer,
|
|
167
|
-
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
168
|
-
or other liability obligations and/or rights consistent with this
|
|
169
|
-
License. However, in accepting such obligations, You may act only
|
|
170
|
-
on Your own behalf and on Your sole responsibility, not on behalf
|
|
171
|
-
of any other Contributor, and only if You agree to indemnify,
|
|
172
|
-
defend, and hold each Contributor harmless for any liability
|
|
173
|
-
incurred by, or claims asserted against, such Contributor by reason
|
|
174
|
-
of your accepting any such warranty or additional liability.
|
|
175
|
-
|
|
176
|
-
END OF TERMS AND CONDITIONS
|
|
177
|
-
|
|
178
|
-
APPENDIX: How to apply the Apache License to your work.
|
|
179
|
-
|
|
180
|
-
To apply the Apache License to your work, attach the following
|
|
181
|
-
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
182
|
-
replaced with your own identifying information. (Don't include
|
|
183
|
-
the brackets!) The text should be enclosed in the appropriate
|
|
184
|
-
comment syntax for the file format. We also recommend that a
|
|
185
|
-
file or class name and description of purpose be included on the
|
|
186
|
-
same "printed page" as the copyright notice for easier
|
|
187
|
-
identification within third-party archives.
|
|
188
|
-
|
|
189
|
-
Copyright [2023] [Defense Unicorns]
|
|
190
|
-
|
|
191
|
-
Licensed under the Apache License, Version 2.0 (the "License");
|
|
192
|
-
you may not use this file except in compliance with the License.
|
|
193
|
-
You may obtain a copy of the License at
|
|
194
|
-
|
|
195
|
-
http://www.apache.org/licenses/LICENSE-2.0
|
|
196
|
-
|
|
197
|
-
Unless required by applicable law or agreed to in writing, software
|
|
198
|
-
distributed under the License is distributed on an "AS IS" BASIS,
|
|
199
|
-
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
200
|
-
See the License for the specific language governing permissions and
|
|
201
|
-
limitations under the License.
|
package/website/README.md
DELETED
|
@@ -1,50 +0,0 @@
|
|
|
1
|
-
# Doc Site Template
|
|
2
|
-
|
|
3
|
-
[](https://github.com/defenseunicorns/doc-site-template/actions)
|
|
4
|
-
|
|
5
|
-
This site uses the [Defense Unicorns](https://github.com/defenseunicorns/defense-unicorns-hugo-theme) theme for Hugo
|
|
6
|
-
which is a fork of the Google Docsy theme. The Docsy documentation can be used as a guide for [building content](https://www.docsy.dev/docs/adding-content/).
|
|
7
|
-
|
|
8
|
-
## Contributing
|
|
9
|
-
|
|
10
|
-
This repository enforces [Conventional Commit](https://www.conventionalcommits.org/en/v1.0.0/) messages. See the
|
|
11
|
-
documentation for [`release-please`](https://github.com/googleapis/release-please#how-should-i-write-my-commits) for correctly formatting commit messages. [This video](https://www.youtube.com/watch?v=lwGcnDgwmFc&ab_channel=Syntax) does a good job of showing how to add the `Conventional Commit` VSCode extension to use when creating the commit messages.
|
|
12
|
-
|
|
13
|
-
#### Prerequisites
|
|
14
|
-
|
|
15
|
-
[Hugo](https://gohugo.io/documentation/) is required in order to utilize the doc site template. You can run `brew install hugo` to quickly install or see the [installation page](https://gohugo.io/installation/) for additional install methods.
|
|
16
|
-
|
|
17
|
-
## Getting Started
|
|
18
|
-
|
|
19
|
-
Create a new repository from this template:
|
|
20
|
-
|
|
21
|
-

|
|
22
|
-
|
|
23
|
-
Clone your new site:
|
|
24
|
-
|
|
25
|
-
```bash
|
|
26
|
-
git clone <git repo>
|
|
27
|
-
cd <new repo>
|
|
28
|
-
npm ci
|
|
29
|
-
```
|
|
30
|
-
|
|
31
|
-
To run the site for local development:
|
|
32
|
-
|
|
33
|
-
```bash
|
|
34
|
-
npm start
|
|
35
|
-
```
|
|
36
|
-
|
|
37
|
-
Then navigate to [http://localhost:1313/](http://localhost:1313/)
|
|
38
|
-
|
|
39
|
-
## Style guide
|
|
40
|
-
|
|
41
|
-
You can modify the color theme to match your product's by changing the `$secondary` color variable in [_variables_project.scss](assets/scss/_variables_project.scss).
|
|
42
|
-
|
|
43
|
-
[Color Palette](https://www.figma.com/file/aNnt9Ip7IFTs9hnfqrYGl4/Unicorn-UI?type=design&mode=design)
|
|
44
|
-
|
|
45
|
-
To modify the favicon, replace the Doug icons in `static/favicons` with the icons of your choosing. You can use
|
|
46
|
-
[IconGen](http://cthedot.de/icongen) to create the icons in the multiple sizes needed. Make sure and replace all of the
|
|
47
|
-
sizes or it will use the theme's default of Doug.
|
|
48
|
-
|
|
49
|
-
To modify the logo on your Navbar, change the `navbar_logo` setting under `params.ui` in `hugo.toml`. The logo should be
|
|
50
|
-
an SVG.
|