mirror of
https://github.com/yannh/kubeconform.git
synced 2026-04-29 06:44:30 +00:00
fix: Github -> GitHub (#340)
Signed-off-by: George Gaál <gb12335@gmail.com>
This commit is contained in:
parent
e65429b1e5
commit
c7f8490e52
15 changed files with 43 additions and 43 deletions
|
|
@ -8,7 +8,7 @@
|
|||
<div id=main-container><div id=header>
|
||||
<ul id=navigation>
|
||||
<li><a href=/about>About</a></li>
|
||||
<li><a href=https://github.com/yannh/kubeconform/>Github</a></li>
|
||||
<li><a href=https://github.com/yannh/kubeconform/>GitHub</a></li>
|
||||
<li><a href=/docs/installation/>Docs</a></li>
|
||||
<li><a href=/>Home</a></li>
|
||||
</ul>
|
||||
|
|
@ -21,7 +21,7 @@
|
|||
<li><a href=http://kubeconform.mandragor.org/docs/usage/>Usage</a></li>
|
||||
<li><a href=http://kubeconform.mandragor.org/docs/crd-support/>Custom Resources support</a></li>
|
||||
<li><a href=http://kubeconform.mandragor.org/docs/json-schema-conversion/>OpenAPI to JSON Schema conversion</a></li>
|
||||
<li><a href=http://kubeconform.mandragor.org/docs/usage-as-github-action/>Github Action</a></li>
|
||||
<li><a href=http://kubeconform.mandragor.org/docs/usage-as-github-action/>GitHub Action</a></li>
|
||||
<li><a href=http://kubeconform.mandragor.org/docs/using-as-a-go-module/>Kubeconform as a Go module</a></li>
|
||||
</ul>
|
||||
<div id=main>
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@ For example, for Linux on x86_64 architecture:
|
|||
curl -L https://github.com/yannh/kubeconform/releases/latest/download/kubeconform-linux-amd64.tar.gz | tar xvzf - && \ sudo mv kubeconform /usr/local/bin/ MacOs Kubeconform is available to install using Homebrew: $ brew install kubeconform
|
||||
Windows Download the latest release from our release page.</description></item><item><title>Usage</title><link>http://kubeconform.mandragor.org/docs/usage/</link><pubDate>Fri, 02 Jul 2021 00:00:00 +0000</pubDate><guid>http://kubeconform.mandragor.org/docs/usage/</guid><description>$ ./bin/kubeconform -h Usage: ./bin/kubeconform [OPTION]... [FILE OR FOLDER]... -cache string cache schemas downloaded via HTTP to this folder -cpu-prof string debug - log CPU profiling to file -exit-on-error immediately stop execution when the first error is encountered -h show help information -ignore-filename-pattern value regular expression specifying paths to ignore (can be specified multiple times) -ignore-missing-schemas skip files with missing schemas instead of failing -insecure-skip-tls-verify disable verification of the server's SSL certificate.</description></item><item><title>Custom Resources support</title><link>http://kubeconform.mandragor.org/docs/crd-support/</link><pubDate>Fri, 02 Jul 2021 00:00:00 +0000</pubDate><guid>http://kubeconform.mandragor.org/docs/crd-support/</guid><description>When the -schema-location parameter is not used, or set to &ldquo;default&rdquo;, kubeconform will default to downloading schemas from https://github.com/yannh/kubernetes-json-schema. Kubeconform however supports passing one, or multiple, schemas locations - HTTP(s) URLs, or local filesystem paths, in which case it will lookup for schema definitions in each of them, in order, stopping as soon as a matching file is found.
|
||||
If the -schema-location value does not end with &lsquo;.json&rsquo;, Kubeconform will assume filenames / a file structure identical to that of kubernetesjsonschema.</description></item><item><title>OpenAPI to JSON Schema conversion</title><link>http://kubeconform.mandragor.org/docs/json-schema-conversion/</link><pubDate>Fri, 02 Jul 2021 00:00:00 +0000</pubDate><guid>http://kubeconform.mandragor.org/docs/json-schema-conversion/</guid><description>Kubeconform uses JSON schemas to validate Kubernetes resources. For custom resources, the CustomResourceDefinition first needs to be converted to JSON Schema. A script is provided to convert these CustomResourceDefinitions to JSON schema. Here is an example how to use it:
|
||||
#!/bin/bash $ ./scripts/openapi2jsonschema.py https://raw.githubusercontent.com/aws/amazon-sagemaker-operator-for-k8s/master/config/crd/bases/sagemaker.aws.amazon.com_trainingjobs.yaml JSON schema written to trainingjob_v1.json The FILENAME_FORMAT environment variable can be used to change the output file name (Available variables: kind, group, version) (Default: {kind}_{version}).</description></item><item><title>Github Action</title><link>http://kubeconform.mandragor.org/docs/usage-as-github-action/</link><pubDate>Fri, 02 Jul 2021 00:00:00 +0000</pubDate><guid>http://kubeconform.mandragor.org/docs/usage-as-github-action/</guid><description>Kubeconform is publishes Docker Images to Github&rsquo;s new Container Registry, ghcr.io. These images can be used directly in a Github Action, once logged in using a Github Token.
|
||||
name: kubeconform on: push jobs: kubeconform: runs-on: ubuntu-latest steps: - name: login to Github Packages run: echo "${{ github.token }}" | docker login https://ghcr.io -u ${GITHUB_ACTOR} --password-stdin - uses: actions/checkout@v2 - uses: docker://ghcr.io/yannh/kubeconform:master with: entrypoint: '/kubeconform' args: "-summary -output json kubeconfigs/" Note on pricing: Kubeconform relies on Github Container Registry which is currently in Beta.</description></item><item><title>Kubeconform as a Go module</title><link>http://kubeconform.mandragor.org/docs/using-as-a-go-module/</link><pubDate>Fri, 02 Jul 2021 00:00:00 +0000</pubDate><guid>http://kubeconform.mandragor.org/docs/using-as-a-go-module/</guid><description>Warning: This is a work-in-progress, the interface is not yet considered stable. Feedback is encouraged.
|
||||
#!/bin/bash $ ./scripts/openapi2jsonschema.py https://raw.githubusercontent.com/aws/amazon-sagemaker-operator-for-k8s/master/config/crd/bases/sagemaker.aws.amazon.com_trainingjobs.yaml JSON schema written to trainingjob_v1.json The FILENAME_FORMAT environment variable can be used to change the output file name (Available variables: kind, group, version) (Default: {kind}_{version}).</description></item><item><title>GitHub Action</title><link>http://kubeconform.mandragor.org/docs/usage-as-github-action/</link><pubDate>Fri, 02 Jul 2021 00:00:00 +0000</pubDate><guid>http://kubeconform.mandragor.org/docs/usage-as-github-action/</guid><description>Kubeconform is publishes Docker Images to GitHub&rsquo;s new Container Registry, ghcr.io. These images can be used directly in a GitHub Action, once logged in using a GitHub Token.
|
||||
name: kubeconform on: push jobs: kubeconform: runs-on: ubuntu-latest steps: - name: login to GitHub Packages run: echo "${{ github.token }}" | docker login https://ghcr.io -u ${GITHUB_ACTOR} --password-stdin - uses: actions/checkout@v2 - uses: docker://ghcr.io/yannh/kubeconform:master with: entrypoint: '/kubeconform' args: "-summary -output json kubeconfigs/" Note on pricing: Kubeconform relies on GitHub Container Registry which is currently in Beta.</description></item><item><title>Kubeconform as a Go module</title><link>http://kubeconform.mandragor.org/docs/using-as-a-go-module/</link><pubDate>Fri, 02 Jul 2021 00:00:00 +0000</pubDate><guid>http://kubeconform.mandragor.org/docs/using-as-a-go-module/</guid><description>Warning: This is a work-in-progress, the interface is not yet considered stable. Feedback is encouraged.
|
||||
Kubeconform contains a package that can be used as a library. An example of usage can be found in examples/main.go
|
||||
Additional documentation on pkg.go.dev</description></item></channel></rss>
|
||||
|
|
@ -8,7 +8,7 @@
|
|||
<div id=main-container><div id=header>
|
||||
<ul id=navigation>
|
||||
<li><a href=/about>About</a></li>
|
||||
<li><a href=https://github.com/yannh/kubeconform/>Github</a></li>
|
||||
<li><a href=https://github.com/yannh/kubeconform/>GitHub</a></li>
|
||||
<li><a href=/docs/installation/>Docs</a></li>
|
||||
<li><a href=/>Home</a></li>
|
||||
</ul>
|
||||
|
|
@ -21,7 +21,7 @@
|
|||
<li><a href=http://kubeconform.mandragor.org/docs/usage/>Usage</a></li>
|
||||
<li><a href=http://kubeconform.mandragor.org/docs/crd-support/>Custom Resources support</a></li>
|
||||
<li><a href=http://kubeconform.mandragor.org/docs/json-schema-conversion/>OpenAPI to JSON Schema conversion</a></li>
|
||||
<li><a href=http://kubeconform.mandragor.org/docs/usage-as-github-action/>Github Action</a></li>
|
||||
<li><a href=http://kubeconform.mandragor.org/docs/usage-as-github-action/>GitHub Action</a></li>
|
||||
<li><a href=http://kubeconform.mandragor.org/docs/using-as-a-go-module/>Kubeconform as a Go module</a></li>
|
||||
</ul>
|
||||
<div id=main>
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@
|
|||
<div id=main-container><div id=header>
|
||||
<ul id=navigation>
|
||||
<li><a href=/about>About</a></li>
|
||||
<li><a href=https://github.com/yannh/kubeconform/>Github</a></li>
|
||||
<li><a href=https://github.com/yannh/kubeconform/>GitHub</a></li>
|
||||
<li><a href=/docs/installation/>Docs</a></li>
|
||||
<li><a href=/>Home</a></li>
|
||||
</ul>
|
||||
|
|
@ -21,13 +21,13 @@
|
|||
<li><a href=http://kubeconform.mandragor.org/docs/usage/>Usage</a></li>
|
||||
<li><a href=http://kubeconform.mandragor.org/docs/crd-support/>Custom Resources support</a></li>
|
||||
<li><a href=http://kubeconform.mandragor.org/docs/json-schema-conversion/>OpenAPI to JSON Schema conversion</a></li>
|
||||
<li><a href=http://kubeconform.mandragor.org/docs/usage-as-github-action/>Github Action</a></li>
|
||||
<li><a href=http://kubeconform.mandragor.org/docs/usage-as-github-action/>GitHub Action</a></li>
|
||||
<li><a href=http://kubeconform.mandragor.org/docs/using-as-a-go-module/>Kubeconform as a Go module</a></li>
|
||||
</ul>
|
||||
<div id=main>
|
||||
<div class=navig>
|
||||
<a href=http://kubeconform.mandragor.org/docs/crd-support/ id=prev>< Custom Resources support</a>
|
||||
<a href=http://kubeconform.mandragor.org/docs/usage-as-github-action/ id=next>Github Action ></a>
|
||||
<a href=http://kubeconform.mandragor.org/docs/usage-as-github-action/ id=next>GitHub Action ></a>
|
||||
</div>
|
||||
<div id=content-text>
|
||||
<h1>OpenAPI to JSON Schema conversion</h1>
|
||||
|
|
@ -47,7 +47,7 @@ JSON schema written to trainingjob-sagemaker-v1.json
|
|||
</div>
|
||||
<div class=navig>
|
||||
<a href=http://kubeconform.mandragor.org/docs/crd-support/ id=prev>< Custom Resources support</a>
|
||||
<a href=http://kubeconform.mandragor.org/docs/usage-as-github-action/ id=next>Github Action ></a>
|
||||
<a href=http://kubeconform.mandragor.org/docs/usage-as-github-action/ id=next>GitHub Action ></a>
|
||||
</div>
|
||||
<script defer src=/js/prism.js></script>
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -2,13 +2,13 @@
|
|||
<meta charset=utf-8>
|
||||
<meta name=author content="Yann Hamon">
|
||||
<link rel=stylesheet type=text/css href=/css/style.css><link rel=stylesheet type=text/css href=/css/prism.css>
|
||||
<title>Kubeconform - Fast Kubernetes manifests validation! | Github Action</title>
|
||||
<title>Kubeconform - Fast Kubernetes manifests validation! | GitHub Action</title>
|
||||
</head>
|
||||
<body>
|
||||
<div id=main-container><div id=header>
|
||||
<ul id=navigation>
|
||||
<li><a href=/about>About</a></li>
|
||||
<li><a href=https://github.com/yannh/kubeconform/>Github</a></li>
|
||||
<li><a href=https://github.com/yannh/kubeconform/>GitHub</a></li>
|
||||
<li><a href=/docs/installation/>Docs</a></li>
|
||||
<li><a href=/>Home</a></li>
|
||||
</ul>
|
||||
|
|
@ -21,7 +21,7 @@
|
|||
<li><a href=http://kubeconform.mandragor.org/docs/usage/>Usage</a></li>
|
||||
<li><a href=http://kubeconform.mandragor.org/docs/crd-support/>Custom Resources support</a></li>
|
||||
<li><a href=http://kubeconform.mandragor.org/docs/json-schema-conversion/>OpenAPI to JSON Schema conversion</a></li>
|
||||
<li><a href=http://kubeconform.mandragor.org/docs/usage-as-github-action/>Github Action</a></li>
|
||||
<li><a href=http://kubeconform.mandragor.org/docs/usage-as-github-action/>GitHub Action</a></li>
|
||||
<li><a href=http://kubeconform.mandragor.org/docs/using-as-a-go-module/>Kubeconform as a Go module</a></li>
|
||||
</ul>
|
||||
<div id=main>
|
||||
|
|
@ -30,16 +30,16 @@
|
|||
<a href=http://kubeconform.mandragor.org/docs/using-as-a-go-module/ id=next>Kubeconform as a Go module ></a>
|
||||
</div>
|
||||
<div id=content-text>
|
||||
<h1>Github Action</h1>
|
||||
<p>Kubeconform is publishes Docker Images to Github’s new Container Registry, ghcr.io. These images
|
||||
can be used directly in a Github Action, once logged in using a <a href=https://github.blog/changelog/2021-03-24-packages-container-registry-now-supports-github_token/><em>Github Token</em></a>.</p>
|
||||
<h1>GitHub Action</h1>
|
||||
<p>Kubeconform is publishes Docker Images to GitHub’s new Container Registry, ghcr.io. These images
|
||||
can be used directly in a GitHub Action, once logged in using a <a href=https://github.blog/changelog/2021-03-24-packages-container-registry-now-supports-github_token/><em>GitHub Token</em></a>.</p>
|
||||
<pre><code class=language-bash>name: kubeconform
|
||||
on: push
|
||||
jobs:
|
||||
kubeconform:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: login to Github Packages
|
||||
- name: login to GitHub Packages
|
||||
run: echo "${{ github.token }}" | docker login https://ghcr.io -u ${GITHUB_ACTOR} --password-stdin
|
||||
- uses: actions/checkout@v2
|
||||
- uses: docker://ghcr.io/yannh/kubeconform:master
|
||||
|
|
@ -47,10 +47,10 @@ jobs:
|
|||
entrypoint: '/kubeconform'
|
||||
args: "-summary -output json kubeconfigs/"
|
||||
</code></pre>
|
||||
<p><em>Note on pricing</em>: Kubeconform relies on Github Container Registry which is currently in Beta. During that period,
|
||||
<p><em>Note on pricing</em>: Kubeconform relies on GitHub Container Registry which is currently in Beta. During that period,
|
||||
<a href=https://docs.github.com/en/packages/guides/about-github-container-registry>bandwidth is free</a>. After that period,
|
||||
bandwidth costs might be applicable. Since bandwidth from Github Packages within Github Actions is free, I expect
|
||||
Github Container Registry to also be usable for free within Github Actions in the future. If that were not to be the
|
||||
bandwidth costs might be applicable. Since bandwidth from GitHub Packages within GitHub Actions is free, I expect
|
||||
GitHub Container Registry to also be usable for free within GitHub Actions in the future. If that were not to be the
|
||||
case, I might publish the Docker image to a different platform.</p>
|
||||
</div>
|
||||
<div class=navig>
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@
|
|||
<div id=main-container><div id=header>
|
||||
<ul id=navigation>
|
||||
<li><a href=/about>About</a></li>
|
||||
<li><a href=https://github.com/yannh/kubeconform/>Github</a></li>
|
||||
<li><a href=https://github.com/yannh/kubeconform/>GitHub</a></li>
|
||||
<li><a href=/docs/installation/>Docs</a></li>
|
||||
<li><a href=/>Home</a></li>
|
||||
</ul>
|
||||
|
|
@ -21,7 +21,7 @@
|
|||
<li><a href=http://kubeconform.mandragor.org/docs/usage/>Usage</a></li>
|
||||
<li><a href=http://kubeconform.mandragor.org/docs/crd-support/>Custom Resources support</a></li>
|
||||
<li><a href=http://kubeconform.mandragor.org/docs/json-schema-conversion/>OpenAPI to JSON Schema conversion</a></li>
|
||||
<li><a href=http://kubeconform.mandragor.org/docs/usage-as-github-action/>Github Action</a></li>
|
||||
<li><a href=http://kubeconform.mandragor.org/docs/usage-as-github-action/>GitHub Action</a></li>
|
||||
<li><a href=http://kubeconform.mandragor.org/docs/using-as-a-go-module/>Kubeconform as a Go module</a></li>
|
||||
</ul>
|
||||
<div id=main>
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@
|
|||
<div id=main-container><div id=header>
|
||||
<ul id=navigation>
|
||||
<li><a href=/about>About</a></li>
|
||||
<li><a href=https://github.com/yannh/kubeconform/>Github</a></li>
|
||||
<li><a href=https://github.com/yannh/kubeconform/>GitHub</a></li>
|
||||
<li><a href=/docs/installation/>Docs</a></li>
|
||||
<li><a href=/>Home</a></li>
|
||||
</ul>
|
||||
|
|
@ -21,12 +21,12 @@
|
|||
<li><a href=http://kubeconform.mandragor.org/docs/usage/>Usage</a></li>
|
||||
<li><a href=http://kubeconform.mandragor.org/docs/crd-support/>Custom Resources support</a></li>
|
||||
<li><a href=http://kubeconform.mandragor.org/docs/json-schema-conversion/>OpenAPI to JSON Schema conversion</a></li>
|
||||
<li><a href=http://kubeconform.mandragor.org/docs/usage-as-github-action/>Github Action</a></li>
|
||||
<li><a href=http://kubeconform.mandragor.org/docs/usage-as-github-action/>GitHub Action</a></li>
|
||||
<li><a href=http://kubeconform.mandragor.org/docs/using-as-a-go-module/>Kubeconform as a Go module</a></li>
|
||||
</ul>
|
||||
<div id=main>
|
||||
<div class=navig>
|
||||
<a href=http://kubeconform.mandragor.org/docs/usage-as-github-action/ id=prev>< Github Action</a>
|
||||
<a href=http://kubeconform.mandragor.org/docs/usage-as-github-action/ id=prev>< GitHub Action</a>
|
||||
<a href=# id=prev></a>
|
||||
</div>
|
||||
<div id=content-text>
|
||||
|
|
@ -37,7 +37,7 @@ An example of usage can be found in <a href=https://github.com/yannh/kubeconform
|
|||
<p>Additional documentation on <a href=https://pkg.go.dev/github.com/yannh/kubeconform/pkg/validator>pkg.go.dev</a></p>
|
||||
</div>
|
||||
<div class=navig>
|
||||
<a href=http://kubeconform.mandragor.org/docs/usage-as-github-action/ id=prev>< Github Action</a>
|
||||
<a href=http://kubeconform.mandragor.org/docs/usage-as-github-action/ id=prev>< GitHub Action</a>
|
||||
<a href=# id=prev></a>
|
||||
</div>
|
||||
<script defer src=/js/prism.js></script>
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue