update README,docs,helm-docs pre-commit,schema #14

sallyom · 2023-09-02T20:35:30Z

This PR:

updates 'scaffold' to 'upstream' in scaffolding chart
includes sigstore/helm-charts/charts/* schemas in scaffolding schema with securesign images in the default values file.
adds a pre-commit to ensure README & values.schema.json are up to date
adds gotmpl for README and values schema
updates README
adds chart-testing/GH workflow/ct tool for linting

See:

https://github.com/norwoodj/helm-docs
https://pre-commit.com/
https://github.com/helm/chart-testing
https://github.com/janus-idp/helm-backstage .pre-commit-config.yaml

For follow-up:

update json schema template with examples, more details
update values with pull-secret and the rhtap images
add end-to-end test for deployments' health, etc

examples/values-ez.yaml

examples/values-sigstore-openshift.yaml

sallyom · 2023-09-08T01:14:58Z

@sabre1041 ptal - i've added sigstore/scaffold schema to include quay.io/securesign/images by default in all charts - also following the file structure of other supported helm-charts (backstage)

sallyom · 2023-09-14T20:44:14Z

@sabre1041 @JasonPowr ptal
temporarily using 'quay.io/sallyom/copy-secrets:latest` in copy-secrets-job

sabre1041

A few changes requested

.github/workflows/test.yaml

quick-start-with-keycloak.md

examples/values-sigstore-openshift.yaml

quick-start-with-keycloak.md

examples/values-sigstore-openshift.yaml

quick-start-with-keycloak.md

sabre1041 · 2023-09-19T00:17:33Z

sign-verify.md

-# omit the '*.'
-export BASE_HOSTNAME=apps.something.something.openshiftapps.com
+oc get dns cluster -o jsonpath='{ .spec.baseDomain }'
+export BASE_HOSTNAME=apps.BASE_DOMAIN


Do we want to align the variable OPENSHIFT_APPS_SUBDOMAIN. And then just use a single OPENSHIFT_APPS_SUBDOMAIN=apps.$(oc get dns cluster -o jsonpath='{ .spec.baseDomain }')>

yes, I was thinking that as well - will push that change

updated - we'll want to also update the env variable in the cosign ~~Dockerfile, I'll add that to the list of follow up TODOs~~ Dockerfile/template - done

I updated in default values.yaml from cosign.BASE_DOMAIN to cosign.appsSubdomain

sabre1041

LGTM

sabre1041

LGTM (this time for real)

Signed-off-by: Sally O'Malley <somalley@redhat.com>

* update README,docs,helm-docs pre-commit,schema * update README Signed-off-by: Sally O'Malley <somalley@redhat.com> * add root README * update quickstart doc * add chart-release tools and gh workflow Signed-off-by: Sally O'Malley <somalley@redhat.com> * add rekor secret to quickstart Signed-off-by: Sally O'Malley <somalley@redhat.com> * update README/docs * add clustermonitoring schema Signed-off-by: Sally O'Malley <somalley@redhat.com> * fulcio: set createcerts false * envsubst with OPENSHIFT_BASE_DOMAIN Signed-off-by: Sally O'Malley <somalley@redhat.com> * BASE_DOMAIN to APPS_SUBDOMAIN Signed-off-by: Sally O'Malley <somalley@redhat.com> * update to APPS_SUBDOMAIN in docs Signed-off-by: Sally O'Malley <somalley@redhat.com> * remove test file Signed-off-by: Sally O'Malley <somalley@redhat.com> * update README with monitoring Signed-off-by: Sally O'Malley <somalley@redhat.com> --------- Signed-off-by: Sally O'Malley <somalley@redhat.com>

sallyom force-pushed the update-docs-schema branch 2 times, most recently from 200bb5d to 02cd6a2 Compare September 2, 2023 21:08

JasonPowr reviewed Sep 6, 2023

View reviewed changes

examples/values-ez.yaml Outdated Show resolved Hide resolved

sallyom commented Sep 7, 2023

View reviewed changes

examples/values-sigstore-openshift.yaml Show resolved Hide resolved

sallyom changed the title ~~update README,docs,helm-docs pre-commit,schema~~ WIP: update README,docs,helm-docs pre-commit,schema Sep 8, 2023

sallyom force-pushed the update-docs-schema branch from f4ef4c8 to 79f0889 Compare September 8, 2023 03:19

sallyom changed the title ~~WIP: update README,docs,helm-docs pre-commit,schema~~ update README,docs,helm-docs pre-commit,schema Sep 12, 2023

sallyom force-pushed the update-docs-schema branch 4 times, most recently from 0672cb4 to 9e5b5b6 Compare September 14, 2023 20:41

sallyom force-pushed the update-docs-schema branch 3 times, most recently from c58b14c to a6a37fc Compare September 15, 2023 21:17

sabre1041 suggested changes Sep 16, 2023

View reviewed changes

sabre1041 reviewed Sep 17, 2023

View reviewed changes

quick-start-with-keycloak.md Outdated Show resolved Hide resolved

examples/values-sigstore-openshift.yaml Show resolved Hide resolved

sallyom force-pushed the update-docs-schema branch 2 times, most recently from 3e7bd56 to 25a3c16 Compare September 18, 2023 18:29

sabre1041 reviewed Sep 19, 2023

View reviewed changes

sallyom force-pushed the update-docs-schema branch 4 times, most recently from 92ce7b5 to 0b69809 Compare September 19, 2023 12:30

sabre1041 approved these changes Sep 19, 2023

View reviewed changes

sallyom force-pushed the update-docs-schema branch from 0b69809 to d4b1214 Compare September 19, 2023 16:55

sabre1041 approved these changes Sep 19, 2023

View reviewed changes

sallyom added 2 commits September 19, 2023 13:10

update README,docs,helm-docs pre-commit,schema

d14df8c

update README

09d1db5

Signed-off-by: Sally O'Malley <somalley@redhat.com>

sallyom added 11 commits September 19, 2023 13:11

add root README

4754679

update quickstart doc

e201106

add chart-release tools and gh workflow

7c278ef

Signed-off-by: Sally O'Malley <somalley@redhat.com>

add rekor secret to quickstart

e1c6697

Signed-off-by: Sally O'Malley <somalley@redhat.com>

update README/docs

f5eb452

add clustermonitoring schema

ba8e807

Signed-off-by: Sally O'Malley <somalley@redhat.com>

fulcio: set createcerts false

d99950c

envsubst with OPENSHIFT_BASE_DOMAIN

c0a25fd

Signed-off-by: Sally O'Malley <somalley@redhat.com>

BASE_DOMAIN to APPS_SUBDOMAIN

407ec51

Signed-off-by: Sally O'Malley <somalley@redhat.com>

update to APPS_SUBDOMAIN in docs

b4344bf

Signed-off-by: Sally O'Malley <somalley@redhat.com>

remove test file

c9eae3c

Signed-off-by: Sally O'Malley <somalley@redhat.com>

sallyom force-pushed the update-docs-schema branch from d4b1214 to 868fea0 Compare September 19, 2023 17:22

update README with monitoring

9403c2b

Signed-off-by: Sally O'Malley <somalley@redhat.com>

sallyom force-pushed the update-docs-schema branch from 868fea0 to 9403c2b Compare September 19, 2023 17:23

sallyom merged commit d85e19e into securesign:main Sep 19, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

update README,docs,helm-docs pre-commit,schema #14

update README,docs,helm-docs pre-commit,schema #14

sallyom commented Sep 2, 2023 •

edited

Loading

sallyom commented Sep 8, 2023 •

edited

Loading

sallyom commented Sep 14, 2023

sabre1041 left a comment

sabre1041 Sep 19, 2023

sallyom Sep 19, 2023

sallyom Sep 19, 2023 •

edited

Loading

sallyom Sep 19, 2023

sabre1041 left a comment

sabre1041 left a comment

update README,docs,helm-docs pre-commit,schema #14

update README,docs,helm-docs pre-commit,schema #14

Conversation

sallyom commented Sep 2, 2023 • edited Loading

sallyom commented Sep 8, 2023 • edited Loading

sallyom commented Sep 14, 2023

sabre1041 left a comment

Choose a reason for hiding this comment

sabre1041 Sep 19, 2023

Choose a reason for hiding this comment

sallyom Sep 19, 2023

Choose a reason for hiding this comment

sallyom Sep 19, 2023 • edited Loading

Choose a reason for hiding this comment

sallyom Sep 19, 2023

Choose a reason for hiding this comment

sabre1041 left a comment

Choose a reason for hiding this comment

sabre1041 left a comment

Choose a reason for hiding this comment

sallyom commented Sep 2, 2023 •

edited

Loading

sallyom commented Sep 8, 2023 •

edited

Loading

sallyom Sep 19, 2023 •

edited

Loading