actions/kubeconform
9
0
Fork 0
mirror of https://github.com/yannh/kubeconform.git synced 2026-02-24 04:07:02 +00:00
Code Issues Projects Releases 1 Packages Wiki Activity Actions

Minor css updates

Browse source
This commit is contained in:
Yann Hamon 2021-12-20 00:43:36 +01:00 committed by Yann
parent d10c9bde67
commit 607c90a0a9
22 changed files with 418 additions and 987 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
site/content/docs/overview.md
View file

@ -6,8 +6,8 @@ tags: ["Kubeconform", "Overview"]
weight: 1 weight: 1
--- ---
Kubeconform is a Kubernetes manifests validation tool. Build it into your CI to validate your Kubernetes Kubeconform is a Kubernetes manifests validation tool, and checks whether your Kubernetes manifests
configuration! are valid, according to Kubernetes resources definitions.
It is inspired by, contains code from and is designed to stay close to It is inspired by, contains code from and is designed to stay close to
[Kubeval](https://github.com/instrumenta/kubeval), but with the following improvements: [Kubeval](https://github.com/instrumenta/kubeval), but with the following improvements:
@ -18,6 +18,7 @@ It is inspired by, contains code from and is designed to stay close to
* uses by default a [self-updating fork](https://github.com/yannh/kubernetes-json-schema) of the schemas registry maintained * uses by default a [self-updating fork](https://github.com/yannh/kubernetes-json-schema) of the schemas registry maintained
by the [kubernetes-json-schema](https://github.com/instrumenta/kubernetes-json-schema) project - which guarantees by the [kubernetes-json-schema](https://github.com/instrumenta/kubernetes-json-schema) project - which guarantees
up-to-date **schemas for all recent versions of Kubernetes**. up-to-date **schemas for all recent versions of Kubernetes**.
* improved logging: support for more formats (Tap, Junit, JSON).
### A small overview of Kubernetes manifest validation ### A small overview of Kubernetes manifest validation

72
site/public/about/index.html
View file

@ -1,57 +1,51 @@
<!DOCTYPE html> <!doctype html><html><head>
<html><head> <meta charset=utf-8>
<meta charset="utf-8"> <meta name=author content="Yann Hamon">
<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>
<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! | About</title>
<title>Kubeconform - Fast Kubernetes manifests validation! | About</title>
</head> </head>
<body> <body>
<div id="main-container"><div id="header"> <div id=main-container><div id=header>
<ul id="navigation"> <ul id=navigation>
<li><a href="/about">About</a></li> <li><a href=/about>About</a></li>
<li><a href="/docs/installation/">Docs</a></li> <li><a href=https://github.com/yannh/kubeconform/>Github</a></li>
<li><a href="/">Home</a></li> <li><a href=/docs/installation/>Docs</a></li>
</ul> <li><a href=/>Home</a></li>
<h1>Kubeconform</h1> </ul>
<h2>A fast Kubernetes manifests validator</h2> <h1>Kubeconform</h1>
<h2>A fast Kubernetes manifests validator</h2>
</div> </div>
<div id="content"><div id="main"> <div id=content><div id=main>
<div class=navig>
<div class="navig"> <a href=# id=prev></a>
<a href=# id=prev></a>
</div> </div>
<div id=content-text>
<div id="content-text">
<h1>About</h1> <h1>About</h1>
<p>Kubeconform is a Kubernetes manifests validation tool. Build it into your CI to validate your Kubernetes <p>Kubeconform is a Kubernetes manifests validation tool. Build it into your CI to validate your Kubernetes
configuration!</p> configuration!</p>
<p>It is inspired by, contains code from and is designed to stay close to <p>It is inspired by, contains code from and is designed to stay close to
<a href="https://github.com/instrumenta/kubeval">Kubeval</a>, but with the following improvements:</p> <a href=https://github.com/instrumenta/kubeval>Kubeval</a>, but with the following improvements:</p>
<ul> <ul>
<li><strong>high performance</strong>: will validate &amp; download manifests over multiple routines, caching <li><strong>high performance</strong>: will validate & download manifests over multiple routines, caching
downloaded files in memory</li> downloaded files in memory</li>
<li>configurable list of <strong>remote, or local schemas locations</strong>, enabling validating Kubernetes <li>configurable list of <strong>remote, or local schemas locations</strong>, enabling validating Kubernetes
custom resources (CRDs) and offline validation capabilities</li> custom resources (CRDs) and offline validation capabilities</li>
<li>uses by default a <a href="https://github.com/yannh/kubernetes-json-schema">self-updating fork</a> of the schemas registry maintained <li>uses by default a <a href=https://github.com/yannh/kubernetes-json-schema>self-updating fork</a> of the schemas registry maintained
by the <a href="https://github.com/instrumenta/kubernetes-json-schema">kubernetes-json-schema</a> project - which guarantees by the <a href=https://github.com/instrumenta/kubernetes-json-schema>kubernetes-json-schema</a> project - which guarantees
up-to-date <strong>schemas for all recent versions of Kubernetes</strong>.</li> up-to-date <strong>schemas for all recent versions of Kubernetes</strong>.</li>
</ul> </ul>
</div> </div>
<div class=navig>
<div class="navig"> <a href=# id=prev></a>
<a href=# id=prev></a>
</div> </div>
<script defer src=/js/prism.js></script>
<script defer src="/js/prism.js"></script> </div>
</div><div id=footer>
</div> Website powered by <a href=https://gohugo.io/>Hugo</a>
</div><div id="footer">
Website powered by <a href="https://gohugo.io/">Hugo</a>
</div> </div>
</div> </div>
<script defer src="/js/prism.js"></script> <script defer src=/js/prism.js></script>
</body> </body>
</html> </html>

11
site/public/categories/index.xml
View file

@ -1,10 +1 @@
<?xml version="1.0" encoding="utf-8" standalone="yes"?> <?xml version="1.0" encoding="utf-8" standalone="yes"?><rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom"><channel><title>Categories on Kubeconform - Fast Kubernetes manifests validation!</title><link>http://kubeconform.mandragor.org/categories/</link><description>Recent content in Categories on Kubeconform - Fast Kubernetes manifests validation!</description><generator>Hugo -- gohugo.io</generator><language>en-us</language><atom:link href="http://kubeconform.mandragor.org/categories/index.xml" rel="self" type="application/rss+xml"/></channel></rss>
<rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom">
<channel>
<title>Categories on Kubeconform - Fast Kubernetes manifests validation!</title>
<link>http://kubeconform.mandragor.org/categories/</link>
<description>Recent content in Categories on Kubeconform - Fast Kubernetes manifests validation!</description>
<generator>Hugo -- gohugo.io</generator>
<language>en-us</language><atom:link href="http://kubeconform.mandragor.org/categories/index.xml" rel="self" type="application/rss+xml" />
</channel>
</rss>

23
site/public/css/style.css
View file

@ -63,11 +63,6 @@ hr {
padding: 0.5em 0 0.5em 0em; padding: 0.5em 0 0.5em 0em;
} }
#menu {
background-color: #ddd;
padding: 1em
}
#content { #content {
display:flex; display:flex;
} }
@ -75,9 +70,25 @@ hr {
#menu { #menu {
flex: 15; flex: 15;
min-width: 15%; min-width: 15%;
padding: 2em background-color: #ddd;
padding: 2em;
} }
#menu li {
line-height: 1.9rem;
padding-bottom: 0.6rem;
}
#menu li::marker {
font-size: smaller;
}
#menu li a:hover {
text-decoration: underline;
}
#main { #main {
flex: 85; flex: 85;
min-width: 0; min-width: 0;

111
site/public/docs/crd-support/index.html
View file

@ -1,49 +1,35 @@
<!DOCTYPE html> <!doctype html><html><head>
<html><head> <meta charset=utf-8>
<meta charset="utf-8"> <meta name=author content="Yann Hamon">
<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>
<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! | Custom Resources support</title>
<title>Kubeconform - Fast Kubernetes manifests validation! | Custom Resources support</title>
</head> </head>
<body> <body>
<div id="main-container"><div id="header"> <div id=main-container><div id=header>
<ul id="navigation"> <ul id=navigation>
<li><a href="/about">About</a></li> <li><a href=/about>About</a></li>
<li><a href="/docs/installation/">Docs</a></li> <li><a href=https://github.com/yannh/kubeconform/>Github</a></li>
<li><a href="/">Home</a></li> <li><a href=/docs/installation/>Docs</a></li>
</ul> <li><a href=/>Home</a></li>
<h1>Kubeconform</h1>
<h2>A fast Kubernetes manifests validator</h2>
</div>
<div id="content"><ul id="menu">
<li><a href="http://kubeconform.mandragor.org/docs/overview/">Overview</a></li>
<li><a href="http://kubeconform.mandragor.org/docs/installation/">Installation</a></li>
<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/using-as-a-go-module/">Kubeconform as a Go module</a></li>
</ul> </ul>
<div id="main"> <h1>Kubeconform</h1>
<h2>A fast Kubernetes manifests validator</h2>
<div class="navig">
<a href="http://kubeconform.mandragor.org/docs/usage/" id="prev">&lt; Usage</a>
<a href="http://kubeconform.mandragor.org/docs/json-schema-conversion/" id="next">OpenAPI to JSON Schema conversion &gt;</a>
</div> </div>
<div id=content><ul id=menu>
<div id="content-text"> <li><a href=http://kubeconform.mandragor.org/docs/overview/>Overview</a></li>
<li><a href=http://kubeconform.mandragor.org/docs/installation/>Installation</a></li>
<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/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/ id=prev>&lt; Usage</a>
<a href=http://kubeconform.mandragor.org/docs/json-schema-conversion/ id=next>OpenAPI to JSON Schema conversion ></a>
</div>
<div id=content-text>
<h1>Custom Resources support</h1> <h1>Custom Resources support</h1>
<p>When the <code>-schema-location</code> parameter is not used, or set to &ldquo;default&rdquo;, kubeconform will default to downloading <p>When the <code>-schema-location</code> parameter is not used, or set to &ldquo;default&rdquo;, kubeconform will default to downloading
schemas from <code>https://github.com/yannh/kubernetes-json-schema</code>. Kubeconform however supports passing one, or multiple, schemas from <code>https://github.com/yannh/kubernetes-json-schema</code>. Kubeconform however supports passing one, or multiple,
@ -54,53 +40,42 @@ in each of them, in order, stopping as soon as a matching file is found.</p>
structure identical to that of kubernetesjsonschema.dev or github.com/yannh/kubernetes-json-schema.</li> structure identical to that of kubernetesjsonschema.dev or github.com/yannh/kubernetes-json-schema.</li>
<li>if the -schema-location value ends with &lsquo;.json&rsquo; - Kubeconform assumes the value is a Go templated <li>if the -schema-location value ends with &lsquo;.json&rsquo; - Kubeconform assumes the value is a Go templated
string that indicates how to search for JSON schemas.</li> string that indicates how to search for JSON schemas.</li>
<li>the -schema-location value of &ldquo;default&rdquo; is an alias for <a href="https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/%7B%7B">https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/{{</a> .NormalizedKubernetesVersion }}-standalone{{ .StrictSuffix }}/{{ .ResourceKind }}{{ .KindSuffix }}.json. <li>the -schema-location value of &ldquo;default&rdquo; is an alias for <a href=https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/%7B%7B>https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/{{</a> .NormalizedKubernetesVersion }}-standalone{{ .StrictSuffix }}/{{ .ResourceKind }}{{ .KindSuffix }}.json.
Both following command lines are equivalent:</li> Both following command lines are equivalent:</li>
</ul> </ul>
<pre><code class=language-bash>$ ./bin/kubeconform fixtures/valid.yaml
<pre><code class="language-bash">$ ./bin/kubeconform fixtures/valid.yaml
$ ./bin/kubeconform -schema-location default fixtures/valid.yaml $ ./bin/kubeconform -schema-location default fixtures/valid.yaml
$ ./bin/kubeconform -schema-location 'https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/{{ .NormalizedKubernetesVersion }}-standalone{{ .StrictSuffix }}/{{ .ResourceKind }}{{ .KindSuffix }}.json' fixtures/valid.yaml $ ./bin/kubeconform -schema-location 'https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/{{ .NormalizedKubernetesVersion }}-standalone{{ .StrictSuffix }}/{{ .ResourceKind }}{{ .KindSuffix }}.json' fixtures/valid.yaml
</code></pre> </code></pre>
<p>To support validating CRDs, we need to convert OpenAPI files to JSON schema, storing the JSON schemas <p>To support validating CRDs, we need to convert OpenAPI files to JSON schema, storing the JSON schemas
in a local folder - for example schemas. Then we specify this folder as an additional registry to lookup:</p> in a local folder - for example schemas. Then we specify this folder as an additional registry to lookup:</p>
<pre><code class=language-bash># If the resource Kind is not found in kubernetesjsonschema.dev, also lookup in the schemas/ folder for a matching file
<pre><code class="language-bash"># If the resource Kind is not found in kubernetesjsonschema.dev, also lookup in the schemas/ folder for a matching file
$ ./bin/kubeconform -schema-location default -schema-location 'schemas/{{ .ResourceKind }}{{ .KindSuffix }}.json' fixtures/custom-resource.yaml $ ./bin/kubeconform -schema-location default -schema-location 'schemas/{{ .ResourceKind }}{{ .KindSuffix }}.json' fixtures/custom-resource.yaml
</code></pre> </code></pre>
<p>You can validate Openshift manifests using a custom schema location. Set the OpenShift version to validate <p>You can validate Openshift manifests using a custom schema location. Set the OpenShift version to validate
against using -kubernetes-version.</p> against using -kubernetes-version.</p>
<pre><code class=language-bash>$ ./bin/kubeconform -kubernetes-version 3.8.0 -schema-location 'https://raw.githubusercontent.com/garethr/openshift-json-schema/master/{{ .NormalizedKubernetesVersion }}-standalone{{ .StrictSuffix }}/{{ .ResourceKind }}.json' -summary fixtures/valid.yaml
<pre><code class="language-bash">$ ./bin/kubeconform -kubernetes-version 3.8.0 -schema-location 'https://raw.githubusercontent.com/garethr/openshift-json-schema/master/{{ .NormalizedKubernetesVersion }}-standalone{{ .StrictSuffix }}/{{ .ResourceKind }}.json' -summary fixtures/valid.yaml
Summary: 1 resource found in 1 file - Valid: 1, Invalid: 0, Errors: 0 Skipped: 0 Summary: 1 resource found in 1 file - Valid: 1, Invalid: 0, Errors: 0 Skipped: 0
</code></pre> </code></pre>
<p>Here are the variables you can use in -schema-location:</p> <p>Here are the variables you can use in -schema-location:</p>
<ul> <ul>
<li><em>NormalizedKubernetesVersion</em> - Kubernetes Version, prefixed by v</li> <li><em>NormalizedKubernetesVersion</em> - Kubernetes Version, prefixed by v</li>
<li><em>StrictSuffix</em> - &ldquo;-strict&rdquo; or &quot;&quot; depending on whether validation is running in strict mode or not</li> <li><em>StrictSuffix</em> - &ldquo;-strict&rdquo; or "" depending on whether validation is running in strict mode or not</li>
<li><em>ResourceKind</em> - Kind of the Kubernetes Resource</li> <li><em>ResourceKind</em> - Kind of the Kubernetes Resource</li>
<li><em>ResourceAPIVersion</em> - Version of API used for the resource - &ldquo;v1&rdquo; in &ldquo;apiVersion: monitoring.coreos.com/v1&rdquo;</li> <li><em>ResourceAPIVersion</em> - Version of API used for the resource - &ldquo;v1&rdquo; in &ldquo;apiVersion: monitoring.coreos.com/v1&rdquo;</li>
<li><em>KindSuffix</em> - suffix computed from apiVersion - for compatibility with Kubeval schema registries</li> <li><em>KindSuffix</em> - suffix computed from apiVersion - for compatibility with Kubeval schema registries</li>
</ul> </ul>
</div> </div>
<div class=navig>
<div class="navig"> <a href=http://kubeconform.mandragor.org/docs/usage/ id=prev>&lt; Usage</a>
<a href=http://kubeconform.mandragor.org/docs/json-schema-conversion/ id=next>OpenAPI to JSON Schema conversion ></a>
<a href="http://kubeconform.mandragor.org/docs/usage/" id="prev">&lt; Usage</a>
<a href="http://kubeconform.mandragor.org/docs/json-schema-conversion/" id="next">OpenAPI to JSON Schema conversion &gt;</a>
</div> </div>
<script defer src=/js/prism.js></script>
<script defer src="/js/prism.js"></script> </div>
</div><div id=footer>
</div> Website powered by <a href=https://gohugo.io/>Hugo</a>
</div><div id="footer">
Website powered by <a href="https://gohugo.io/">Hugo</a>
</div> </div>
</div> </div>
<script defer src="/js/prism.js"></script> <script defer src=/js/prism.js></script>
</body> </body>
</html> </html>

89
site/public/docs/index.xml
View file

@ -1,84 +1,11 @@
<?xml version="1.0" encoding="utf-8" standalone="yes"?> <?xml version="1.0" encoding="utf-8" standalone="yes"?><rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom"><channel><title>Docs on Kubeconform - Fast Kubernetes manifests validation!</title><link>http://kubeconform.mandragor.org/docs/</link><description>Recent content in Docs on Kubeconform - Fast Kubernetes manifests validation!</description><generator>Hugo -- gohugo.io</generator><language>en-us</language><lastBuildDate>Fri, 02 Jul 2021 00:00:00 +0000</lastBuildDate><atom:link href="http://kubeconform.mandragor.org/docs/index.xml" rel="self" type="application/rss+xml"/><item><title>Overview</title><link>http://kubeconform.mandragor.org/docs/overview/</link><pubDate>Fri, 02 Jul 2021 00:00:00 +0000</pubDate><guid>http://kubeconform.mandragor.org/docs/overview/</guid><description>Kubeconform is a Kubernetes manifests validation tool, and checks whether your Kubernetes manifests are valid, according to Kubernetes resources definitions.
<rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom">
<channel>
<title>Docs on Kubeconform - Fast Kubernetes manifests validation!</title>
<link>http://kubeconform.mandragor.org/docs/</link>
<description>Recent content in Docs on Kubeconform - Fast Kubernetes manifests validation!</description>
<generator>Hugo -- gohugo.io</generator>
<language>en-us</language>
<lastBuildDate>Fri, 02 Jul 2021 00:00:00 +0000</lastBuildDate><atom:link href="http://kubeconform.mandragor.org/docs/index.xml" rel="self" type="application/rss+xml" />
<item>
<title>Overview</title>
<link>http://kubeconform.mandragor.org/docs/overview/</link>
<pubDate>Fri, 02 Jul 2021 00:00:00 +0000</pubDate>
<guid>http://kubeconform.mandragor.org/docs/overview/</guid>
<description>Kubeconform is a Kubernetes manifests validation tool. Build it into your CI to validate your Kubernetes configuration!
It is inspired by, contains code from and is designed to stay close to Kubeval, but with the following improvements: It is inspired by, contains code from and is designed to stay close to Kubeval, but with the following improvements:
high performance: will validate &amp;amp; download manifests over multiple routines, caching downloaded files in memory configurable list of remote, or local schemas locations, enabling validating Kubernetes custom resources (CRDs) and offline validation capabilities uses by default a self-updating fork of the schemas registry maintained by the kubernetes-json-schema project - which guarantees up-to-date schemas for all recent versions of Kubernetes.</description> high performance: will validate &amp;amp; download manifests over multiple routines, caching downloaded files in memory configurable list of remote, or local schemas locations, enabling validating Kubernetes custom resources (CRDs) and offline validation capabilities uses by default a self-updating fork of the schemas registry maintained by the kubernetes-json-schema project - which guarantees up-to-date schemas for all recent versions of Kubernetes.</description></item><item><title>Installation</title><link>http://kubeconform.mandragor.org/docs/installation/</link><pubDate>Fri, 02 Jul 2021 00:00:00 +0000</pubDate><guid>http://kubeconform.mandragor.org/docs/installation/</guid><description>Linux Download the latest release from our release page.
</item>
<item>
<title>Installation</title>
<link>http://kubeconform.mandragor.org/docs/installation/</link>
<pubDate>Fri, 02 Jul 2021 00:00:00 +0000</pubDate>
<guid>http://kubeconform.mandragor.org/docs/installation/</guid>
<description>Linux Download the latest release from our release page.
For example, for Linux on x86_64 architecture: 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 - &amp;&amp; \ sudo mv kubeconform /usr/local/bin/ MacOs Kubeconform is available to install using Homebrew: $ brew install kubeconform curl -L https://github.com/yannh/kubeconform/releases/latest/download/kubeconform-linux-amd64.tar.gz | tar xvzf - &amp;&amp; \ 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> 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 &amp;ldquo;default&amp;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.
</item> If the -schema-location value does not end with &amp;lsquo;.json&amp;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&amp;rsquo;s new Container Registry, ghcr.io. These images can be used directly in a Github Action, once logged in using a Github Token.
<item> 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.
<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&#39;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 &amp;ldquo;default&amp;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 &amp;lsquo;.json&amp;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&amp;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 &#34;${{ github.token }}&#34; | docker login https://ghcr.io -u ${GITHUB_ACTOR} --password-stdin - uses: actions/checkout@v2 - uses: docker://ghcr.io/yannh/kubeconform:master with: entrypoint: &#39;/kubeconform&#39; args: &#34;-summary -output json kubeconfigs/&#34; 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 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> Additional documentation on pkg.go.dev</description></item></channel></rss>
</item>
</channel>
</rss>

116
site/public/docs/installation/index.html
View file

@ -1,83 +1,59 @@
<!DOCTYPE html> <!doctype html><html><head>
<html><head> <meta charset=utf-8>
<meta charset="utf-8"> <meta name=author content="Yann Hamon">
<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>
<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! | Installation</title>
<title>Kubeconform - Fast Kubernetes manifests validation! | Installation</title>
</head> </head>
<body> <body>
<div id="main-container"><div id="header"> <div id=main-container><div id=header>
<ul id="navigation"> <ul id=navigation>
<li><a href="/about">About</a></li> <li><a href=/about>About</a></li>
<li><a href="/docs/installation/">Docs</a></li> <li><a href=https://github.com/yannh/kubeconform/>Github</a></li>
<li><a href="/">Home</a></li> <li><a href=/docs/installation/>Docs</a></li>
</ul> <li><a href=/>Home</a></li>
<h1>Kubeconform</h1>
<h2>A fast Kubernetes manifests validator</h2>
</div>
<div id="content"><ul id="menu">
<li><a href="http://kubeconform.mandragor.org/docs/overview/">Overview</a></li>
<li><a href="http://kubeconform.mandragor.org/docs/installation/">Installation</a></li>
<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/using-as-a-go-module/">Kubeconform as a Go module</a></li>
</ul> </ul>
<div id="main"> <h1>Kubeconform</h1>
<h2>A fast Kubernetes manifests validator</h2>
<div class="navig">
<a href="http://kubeconform.mandragor.org/docs/overview/" id="prev">&lt; Overview</a>
<a href="http://kubeconform.mandragor.org/docs/usage/" id="next">Usage &gt;</a>
</div> </div>
<div id=content><ul id=menu>
<div id="content-text"> <li><a href=http://kubeconform.mandragor.org/docs/overview/>Overview</a></li>
<li><a href=http://kubeconform.mandragor.org/docs/installation/>Installation</a></li>
<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/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/overview/ id=prev>&lt; Overview</a>
<a href=http://kubeconform.mandragor.org/docs/usage/ id=next>Usage ></a>
</div>
<div id=content-text>
<h1>Installation</h1> <h1>Installation</h1>
<h2 id="linux">Linux</h2> <h2 id=linux>Linux</h2>
<p>Download the latest release from our <a href="https://github.com/yannh/kubeconform/releases">release page</a>.</p> <p>Download the latest release from our <a href=https://github.com/yannh/kubeconform/releases>release page</a>.</p>
<p>For example, for Linux on x86_64 architecture:</p> <p>For example, for Linux on x86_64 architecture:</p>
<pre><code class=language-bash>curl -L https://github.com/yannh/kubeconform/releases/latest/download/kubeconform-linux-amd64.tar.gz | tar xvzf - && \
<pre><code class="language-bash">curl -L https://github.com/yannh/kubeconform/releases/latest/download/kubeconform-linux-amd64.tar.gz | tar xvzf - && \
sudo mv kubeconform /usr/local/bin/ sudo mv kubeconform /usr/local/bin/
</code></pre> </code></pre>
<h2 id="macos">MacOs</h2> <h2 id=macos>MacOs</h2>
<p>Kubeconform is available to install using <a href="https://brew.sh/">Homebrew</a>: <p>Kubeconform is available to install using <a href=https://brew.sh/>Homebrew</a>:
<pre><code class=language-bash>$ brew install kubeconform
<pre><code class="language-bash">$ brew install kubeconform
</code></pre></p> </code></pre></p>
<h2 id="windows">Windows</h2> <h2 id=windows>Windows</h2>
<p>Download the latest release from our <a href="https://github.com/yannh/kubeconform/releases">release page</a>.</p> <p>Download the latest release from our <a href=https://github.com/yannh/kubeconform/releases>release page</a>.</p>
</div> </div>
<div class=navig>
<div class="navig"> <a href=http://kubeconform.mandragor.org/docs/overview/ id=prev>&lt; Overview</a>
<a href=http://kubeconform.mandragor.org/docs/usage/ id=next>Usage ></a>
<a href="http://kubeconform.mandragor.org/docs/overview/" id="prev">&lt; Overview</a>
<a href="http://kubeconform.mandragor.org/docs/usage/" id="next">Usage &gt;</a>
</div> </div>
<script defer src=/js/prism.js></script>
<script defer src="/js/prism.js"></script> </div>
</div><div id=footer>
</div> Website powered by <a href=https://gohugo.io/>Hugo</a>
</div><div id="footer">
Website powered by <a href="https://gohugo.io/">Hugo</a>
</div> </div>
</div> </div>
<script defer src="/js/prism.js"></script> <script defer src=/js/prism.js></script>
</body> </body>
</html> </html>

104
site/public/docs/json-schema-conversion/index.html
View file

@ -1,84 +1,60 @@
<!DOCTYPE html> <!doctype html><html><head>
<html><head> <meta charset=utf-8>
<meta charset="utf-8"> <meta name=author content="Yann Hamon">
<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>
<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! | OpenAPI to JSON Schema conversion</title>
<title>Kubeconform - Fast Kubernetes manifests validation! | OpenAPI to JSON Schema conversion</title>
</head> </head>
<body> <body>
<div id="main-container"><div id="header"> <div id=main-container><div id=header>
<ul id="navigation"> <ul id=navigation>
<li><a href="/about">About</a></li> <li><a href=/about>About</a></li>
<li><a href="/docs/installation/">Docs</a></li> <li><a href=https://github.com/yannh/kubeconform/>Github</a></li>
<li><a href="/">Home</a></li> <li><a href=/docs/installation/>Docs</a></li>
</ul> <li><a href=/>Home</a></li>
<h1>Kubeconform</h1>
<h2>A fast Kubernetes manifests validator</h2>
</div>
<div id="content"><ul id="menu">
<li><a href="http://kubeconform.mandragor.org/docs/overview/">Overview</a></li>
<li><a href="http://kubeconform.mandragor.org/docs/installation/">Installation</a></li>
<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/using-as-a-go-module/">Kubeconform as a Go module</a></li>
</ul> </ul>
<div id="main"> <h1>Kubeconform</h1>
<h2>A fast Kubernetes manifests validator</h2>
<div class="navig">
<a href="http://kubeconform.mandragor.org/docs/crd-support/" id="prev">&lt; Custom Resources support</a>
<a href="http://kubeconform.mandragor.org/docs/usage-as-github-action/" id="next">Github Action &gt;</a>
</div> </div>
<div id=content><ul id=menu>
<div id="content-text"> <li><a href=http://kubeconform.mandragor.org/docs/overview/>Overview</a></li>
<li><a href=http://kubeconform.mandragor.org/docs/installation/>Installation</a></li>
<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/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>&lt; Custom Resources support</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> <h1>OpenAPI to JSON Schema conversion</h1>
<p>Kubeconform uses JSON schemas to validate Kubernetes resources. For custom resources, the CustomResourceDefinition <p>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 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:</p> to JSON schema. Here is an example how to use it:</p>
<pre><code class=language-bash>#!/bin/bash
<pre><code class="language-bash">#!/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 $ ./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 JSON schema written to trainingjob_v1.json
</code></pre> </code></pre>
<p>The <code>FILENAME_FORMAT</code> environment variable can be used to change the output file name (Available variables: <code>kind</code>, <code>group</code>, <code>version</code>) (Default: <code>{kind}_{version}</code>).</p> <p>The <code>FILENAME_FORMAT</code> environment variable can be used to change the output file name (Available variables: <code>kind</code>, <code>group</code>, <code>version</code>) (Default: <code>{kind}_{version}</code>).</p>
<pre><code class=language-bash>$ export FILENAME_FORMAT='{kind}-{group}-{version}'
<pre><code class="language-bash">$ export FILENAME_FORMAT='{kind}-{group}-{version}'
$ ./scripts/openapi2jsonschema.py https://raw.githubusercontent.com/aws/amazon-sagemaker-operator-for-k8s/master/config/crd/bases/sagemaker.aws.amazon.com_trainingjobs.yaml $ ./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-sagemaker-v1.json JSON schema written to trainingjob-sagemaker-v1.json
</code></pre> </code></pre>
<p>Some CRD schemas do not have explicit validation for fields implicitly validated by the Kubernetes API like <code>apiVersion</code>, <code>kind</code>, and <code>metadata</code>, thus additional properties are allowed at the root of the JSON schema by default, if this is not desired the <code>DENY_ROOT_ADDITIONAL_PROPERTIES</code> environment variable can be set to any non-empty value.</p> <p>Some CRD schemas do not have explicit validation for fields implicitly validated by the Kubernetes API like <code>apiVersion</code>, <code>kind</code>, and <code>metadata</code>, thus additional properties are allowed at the root of the JSON schema by default, if this is not desired the <code>DENY_ROOT_ADDITIONAL_PROPERTIES</code> environment variable can be set to any non-empty value.</p>
</div> </div>
<div class=navig>
<div class="navig"> <a href=http://kubeconform.mandragor.org/docs/crd-support/ id=prev>&lt; 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/crd-support/" id="prev">&lt; Custom Resources support</a>
<a href="http://kubeconform.mandragor.org/docs/usage-as-github-action/" id="next">Github Action &gt;</a>
</div> </div>
<script defer src=/js/prism.js></script>
<script defer src="/js/prism.js"></script> </div>
</div><div id=footer>
</div> Website powered by <a href=https://gohugo.io/>Hugo</a>
</div><div id="footer">
Website powered by <a href="https://gohugo.io/">Hugo</a>
</div> </div>
</div> </div>
<script defer src="/js/prism.js"></script> <script defer src=/js/prism.js></script>
</body> </body>
</html> </html>

105
site/public/docs/usage-as-github-action/index.html
View file

@ -1,54 +1,39 @@
<!DOCTYPE html> <!doctype html><html><head>
<html><head> <meta charset=utf-8>
<meta charset="utf-8"> <meta name=author content="Yann Hamon">
<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>
<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> </head>
<body> <body>
<div id="main-container"><div id="header"> <div id=main-container><div id=header>
<ul id="navigation"> <ul id=navigation>
<li><a href="/about">About</a></li> <li><a href=/about>About</a></li>
<li><a href="/docs/installation/">Docs</a></li> <li><a href=https://github.com/yannh/kubeconform/>Github</a></li>
<li><a href="/">Home</a></li> <li><a href=/docs/installation/>Docs</a></li>
</ul> <li><a href=/>Home</a></li>
<h1>Kubeconform</h1>
<h2>A fast Kubernetes manifests validator</h2>
</div>
<div id="content"><ul id="menu">
<li><a href="http://kubeconform.mandragor.org/docs/overview/">Overview</a></li>
<li><a href="http://kubeconform.mandragor.org/docs/installation/">Installation</a></li>
<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/using-as-a-go-module/">Kubeconform as a Go module</a></li>
</ul> </ul>
<div id="main"> <h1>Kubeconform</h1>
<h2>A fast Kubernetes manifests validator</h2>
<div class="navig">
<a href="http://kubeconform.mandragor.org/docs/json-schema-conversion/" id="prev">&lt; OpenAPI to JSON Schema conversion</a>
<a href="http://kubeconform.mandragor.org/docs/using-as-a-go-module/" id="next">Kubeconform as a Go module &gt;</a>
</div> </div>
<div id=content><ul id=menu>
<div id="content-text"> <li><a href=http://kubeconform.mandragor.org/docs/overview/>Overview</a></li>
<li><a href=http://kubeconform.mandragor.org/docs/installation/>Installation</a></li>
<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/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/json-schema-conversion/ id=prev>&lt; OpenAPI to JSON Schema conversion</a>
<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> <h1>Github Action</h1>
<p>Kubeconform is publishes Docker Images to Github&rsquo;s new Container Registry, ghcr.io. These images <p>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 <a href="https://github.blog/changelog/2021-03-24-packages-container-registry-now-supports-github_token/"><em>Github Token</em></a>.</p> 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
<pre><code class="language-bash">name: kubeconform
on: push on: push
jobs: jobs:
kubeconform: kubeconform:
@ -63,29 +48,21 @@ jobs:
args: "-summary -output json kubeconfigs/" args: "-summary -output json kubeconfigs/"
</code></pre> </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, <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 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 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> case, I might publish the Docker image to a different platform.</p>
</div> </div>
<div class=navig>
<div class="navig"> <a href=http://kubeconform.mandragor.org/docs/json-schema-conversion/ id=prev>&lt; OpenAPI to JSON Schema conversion</a>
<a href=http://kubeconform.mandragor.org/docs/using-as-a-go-module/ id=next>Kubeconform as a Go module ></a>
<a href="http://kubeconform.mandragor.org/docs/json-schema-conversion/" id="prev">&lt; OpenAPI to JSON Schema conversion</a>
<a href="http://kubeconform.mandragor.org/docs/using-as-a-go-module/" id="next">Kubeconform as a Go module &gt;</a>
</div> </div>
<script defer src=/js/prism.js></script>
<script defer src="/js/prism.js"></script> </div>
</div><div id=footer>
</div> Website powered by <a href=https://gohugo.io/>Hugo</a>
</div><div id="footer">
Website powered by <a href="https://gohugo.io/">Hugo</a>
</div> </div>
</div> </div>
<script defer src="/js/prism.js"></script> <script defer src=/js/prism.js></script>
</body> </body>
</html> </html>

121
site/public/docs/usage/index.html
View file

@ -1,52 +1,37 @@
<!DOCTYPE html> <!doctype html><html><head>
<html><head> <meta charset=utf-8>
<meta charset="utf-8"> <meta name=author content="Yann Hamon">
<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>
<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! | Usage</title>
<title>Kubeconform - Fast Kubernetes manifests validation! | Usage</title>
</head> </head>
<body> <body>
<div id="main-container"><div id="header"> <div id=main-container><div id=header>
<ul id="navigation"> <ul id=navigation>
<li><a href="/about">About</a></li> <li><a href=/about>About</a></li>
<li><a href="/docs/installation/">Docs</a></li> <li><a href=https://github.com/yannh/kubeconform/>Github</a></li>
<li><a href="/">Home</a></li> <li><a href=/docs/installation/>Docs</a></li>
</ul> <li><a href=/>Home</a></li>
<h1>Kubeconform</h1>
<h2>A fast Kubernetes manifests validator</h2>
</div>
<div id="content"><ul id="menu">
<li><a href="http://kubeconform.mandragor.org/docs/overview/">Overview</a></li>
<li><a href="http://kubeconform.mandragor.org/docs/installation/">Installation</a></li>
<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/using-as-a-go-module/">Kubeconform as a Go module</a></li>
</ul> </ul>
<div id="main"> <h1>Kubeconform</h1>
<h2>A fast Kubernetes manifests validator</h2>
<div class="navig">
<a href="http://kubeconform.mandragor.org/docs/installation/" id="prev">&lt; Installation</a>
<a href="http://kubeconform.mandragor.org/docs/crd-support/" id="next">Custom Resources support &gt;</a>
</div> </div>
<div id=content><ul id=menu>
<div id="content-text"> <li><a href=http://kubeconform.mandragor.org/docs/overview/>Overview</a></li>
<li><a href=http://kubeconform.mandragor.org/docs/installation/>Installation</a></li>
<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/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/installation/ id=prev>&lt; Installation</a>
<a href=http://kubeconform.mandragor.org/docs/crd-support/ id=next>Custom Resources support ></a>
</div>
<div id=content-text>
<h1>Usage</h1> <h1>Usage</h1>
<pre><code class=language-bash>$ ./bin/kubeconform -h
<pre><code class="language-bash">$ ./bin/kubeconform -h
Usage: ./bin/kubeconform [OPTION]... [FILE OR FOLDER]... Usage: ./bin/kubeconform [OPTION]... [FILE OR FOLDER]...
-cache string -cache string
cache schemas downloaded via HTTP to this folder cache schemas downloaded via HTTP to this folder
@ -81,15 +66,13 @@ Usage: ./bin/kubeconform [OPTION]... [FILE OR FOLDER]...
-verbose -verbose
print results for all resources (ignored for tap and junit output) print results for all resources (ignored for tap and junit output)
</code></pre> </code></pre>
<h3 id="validating-a-single-valid-file">Validating a single, valid file</h3> <h3 id=validating-a-single-valid-file>Validating a single, valid file</h3>
<pre><code class=language-bash>$ ./bin/kubeconform fixtures/valid.yaml
<pre><code class="language-bash">$ ./bin/kubeconform fixtures/valid.yaml
$ echo $? $ echo $?
0 0
</code></pre> </code></pre>
<h3 id="validating-a-single-invalid-file-setting-output-to-json-and-printing-a-summary">Validating a single invalid file, setting output to json, and printing a summary</h3> <h3 id=validating-a-single-invalid-file-setting-output-to-json-and-printing-a-summary>Validating a single invalid file, setting output to json, and printing a summary</h3>
<pre><code class=language-bash>$ ./bin/kubeconform -summary -output json fixtures/invalid.yaml
<pre><code class="language-bash">$ ./bin/kubeconform -summary -output json fixtures/invalid.yaml
{ {
"resources": [ "resources": [
{ {
@ -110,38 +93,28 @@ $ echo $?
$ echo $? $ echo $?
1 1
</code></pre> </code></pre>
<h3 id="passing-manifests-via-stdin">Passing manifests via Stdin</h3> <h3 id=passing-manifests-via-stdin>Passing manifests via Stdin</h3>
<pre><code class=language-bash>cat fixtures/valid.yaml | ./bin/kubeconform -summary
<pre><code class="language-bash">cat fixtures/valid.yaml | ./bin/kubeconform -summary
Summary: 1 resource found parsing stdin - Valid: 1, Invalid: 0, Errors: 0 Skipped: 0 Summary: 1 resource found parsing stdin - Valid: 1, Invalid: 0, Errors: 0 Skipped: 0
</code></pre> </code></pre>
<h3 id="validating-a-folder-increasing-the-number-of-parallel-workers">Validating a folder, increasing the number of parallel workers</h3> <h3 id=validating-a-folder-increasing-the-number-of-parallel-workers>Validating a folder, increasing the number of parallel workers</h3>
<pre><code class=language-bash>$ ./bin/kubeconform -summary -n 16 fixtures
<pre><code class="language-bash">$ ./bin/kubeconform -summary -n 16 fixtures
fixtures/crd_schema.yaml - CustomResourceDefinition trainingjobs.sagemaker.aws.amazon.com failed validation: could not find schema for CustomResourceDefinition fixtures/crd_schema.yaml - CustomResourceDefinition trainingjobs.sagemaker.aws.amazon.com failed validation: could not find schema for CustomResourceDefinition
fixtures/invalid.yaml - ReplicationController bob is invalid: Invalid type. Expected: [integer,null], given: string fixtures/invalid.yaml - ReplicationController bob is invalid: Invalid type. Expected: [integer,null], given: string
[...] [...]
Summary: 65 resources found in 34 files - Valid: 55, Invalid: 2, Errors: 8 Skipped: 0 Summary: 65 resources found in 34 files - Valid: 55, Invalid: 2, Errors: 8 Skipped: 0
</code></pre> </code></pre>
</div> </div>
<div class=navig>
<div class="navig"> <a href=http://kubeconform.mandragor.org/docs/installation/ id=prev>&lt; Installation</a>
<a href=http://kubeconform.mandragor.org/docs/crd-support/ id=next>Custom Resources support ></a>
<a href="http://kubeconform.mandragor.org/docs/installation/" id="prev">&lt; Installation</a>
<a href="http://kubeconform.mandragor.org/docs/crd-support/" id="next">Custom Resources support &gt;</a>
</div> </div>
<script defer src=/js/prism.js></script>
<script defer src="/js/prism.js"></script> </div>
</div><div id=footer>
</div> Website powered by <a href=https://gohugo.io/>Hugo</a>
</div><div id="footer">
Website powered by <a href="https://gohugo.io/">Hugo</a>
</div> </div>
</div> </div>
<script defer src="/js/prism.js"></script> <script defer src=/js/prism.js></script>
</body> </body>
</html> </html>

98
site/public/docs/using-as-a-go-module/index.html
View file

@ -1,69 +1,51 @@
<!DOCTYPE html> <!doctype html><html><head>
<html><head> <meta charset=utf-8>
<meta charset="utf-8"> <meta name=author content="Yann Hamon">
<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>
<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! | Kubeconform as a Go module</title>
<title>Kubeconform - Fast Kubernetes manifests validation! | Kubeconform as a Go module</title>
</head> </head>
<body> <body>
<div id="main-container"><div id="header"> <div id=main-container><div id=header>
<ul id="navigation"> <ul id=navigation>
<li><a href="/about">About</a></li> <li><a href=/about>About</a></li>
<li><a href="/docs/installation/">Docs</a></li> <li><a href=https://github.com/yannh/kubeconform/>Github</a></li>
<li><a href="/">Home</a></li> <li><a href=/docs/installation/>Docs</a></li>
</ul> <li><a href=/>Home</a></li>
<h1>Kubeconform</h1>
<h2>A fast Kubernetes manifests validator</h2>
</div>
<div id="content"><ul id="menu">
<li><a href="http://kubeconform.mandragor.org/docs/overview/">Overview</a></li>
<li><a href="http://kubeconform.mandragor.org/docs/installation/">Installation</a></li>
<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/using-as-a-go-module/">Kubeconform as a Go module</a></li>
</ul> </ul>
<div id="main"> <h1>Kubeconform</h1>
<h2>A fast Kubernetes manifests validator</h2>
<div class="navig">
<a href="http://kubeconform.mandragor.org/docs/usage-as-github-action/" id="prev">&lt; Github Action</a>
</div> </div>
<div id=content><ul id=menu>
<div id="content-text"> <li><a href=http://kubeconform.mandragor.org/docs/overview/>Overview</a></li>
<li><a href=http://kubeconform.mandragor.org/docs/installation/>Installation</a></li>
<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/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>&lt; Github Action</a>
<a href=# id=prev></a>
</div>
<div id=content-text>
<h1>Kubeconform as a Go module</h1> <h1>Kubeconform as a Go module</h1>
<p><strong>Warning</strong>: This is a work-in-progress, the interface is not yet considered stable. Feedback is encouraged.</p> <p><strong>Warning</strong>: This is a work-in-progress, the interface is not yet considered stable. Feedback is encouraged.</p>
<p>Kubeconform contains a package that can be used as a library. <p>Kubeconform contains a package that can be used as a library.
An example of usage can be found in <a href="https://github.com/yannh/kubeconform/tree/master/examples/main.go">examples/main.go</a></p> An example of usage can be found in <a href=https://github.com/yannh/kubeconform/tree/master/examples/main.go>examples/main.go</a></p>
<p>Additional documentation on <a href="https://pkg.go.dev/github.com/yannh/kubeconform/pkg/validator">pkg.go.dev</a></p> <p>Additional documentation on <a href=https://pkg.go.dev/github.com/yannh/kubeconform/pkg/validator>pkg.go.dev</a></p>
</div> </div>
<div class=navig>
<div class="navig"> <a href=http://kubeconform.mandragor.org/docs/usage-as-github-action/ id=prev>&lt; Github Action</a>
<a href=# id=prev></a>
<a href="http://kubeconform.mandragor.org/docs/usage-as-github-action/" id="prev">&lt; Github Action</a>
</div> </div>
<script defer src=/js/prism.js></script>
<script defer src="/js/prism.js"></script> </div>
</div><div id=footer>
</div> Website powered by <a href=https://gohugo.io/>Hugo</a>
</div><div id="footer">
Website powered by <a href="https://gohugo.io/">Hugo</a>
</div> </div>
</div> </div>
<script defer src="/js/prism.js"></script> <script defer src=/js/prism.js></script>
</body> </body>
</html> </html>

92
site/public/index.html
View file

@ -1,58 +1,52 @@
<!DOCTYPE html> <!doctype html><html><head>
<html><head> <meta name=generator content="Hugo 0.91.0">
<meta name="generator" content="Hugo 0.91.0" /> <meta charset=utf-8>
<meta charset="utf-8"> <meta name=author content="Yann Hamon">
<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>
<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!</title>
<title>Kubeconform - Fast Kubernetes manifests validation!</title>
</head> </head>
<body> <body>
<div id="main-container"><div id="header"> <div id=main-container><div id=header>
<ul id="navigation"> <ul id=navigation>
<li><a href="/about">About</a></li> <li><a href=/about>About</a></li>
<li><a href="/docs/installation/">Docs</a></li> <li><a href=https://github.com/yannh/kubeconform/>Github</a></li>
<li><a href="/">Home</a></li> <li><a href=/docs/installation/>Docs</a></li>
</ul> <li><a href=/>Home</a></li>
<h1>Kubeconform</h1> </ul>
<h2>A fast Kubernetes manifests validator</h2> <h1>Kubeconform</h1>
<h2>A fast Kubernetes manifests validator</h2>
</div> </div>
<div id="content"><div id="main"> <div id=content><div id=main>
<p id=motto>Validate your Kubernetes manifests instead of deploying broken configuration</p>
<p id="motto">Validate your Kubernetes manifests instead of deploying broken configuration</p> <pre id=demo><code class=language-bash>$ kubeconform -summary myapp/deployment.yaml
<pre id="demo"><code class="language-bash">$ kubeconform -summary myapp/deployment.yaml
Summary: 5 resources found in 1 file - Valid: 5, Invalid: 0, Errors: 0, Skipped: 0 Summary: 5 resources found in 1 file - Valid: 5, Invalid: 0, Errors: 0, Skipped: 0
</code></pre> </code></pre>
<a href=/docs/installation/ id=get>
<a href="/docs/installation/" id="get"> Get Started!
Get Started!
</a> </a>
<div id=kc-pros>
<div id="kc-pros"> <div>
<div> <h2>Easy-to-use</h2>
<h2>Easy-to-use</h2> <p>Single binary, super-easy installation for Windows, Mac & Linux. It takes seconds to get started.</p>
<p>Single binary, super-easy installation for Windows, Mac & Linux. It takes seconds to get started.</p>
</div>
<div>
<h2>Lightning fast</h2>
<p>Kubeconform makes heavy use of Golang's concurrency capabilities, and will spread its workload across multiple cores.</pa>
</div>
<div>
<h2>Support for Kubernetes CRDs</h2>
<p>Validate ALL your Kubernetes resources with Kubeconform's CRD support</p>
</div>
<div>
<h2>Flexible</h2>
<p>With support for JSON, Junit, TAP output, and leveraging the easy-to-use Docker image, you can run Kubeconform in any CI system.</p>
</div>
</div> </div>
<div>
<h2>Lightning fast</h2>
</div> <p>Kubeconform makes heavy use of Golang's concurrency capabilities, and will spread its workload across multiple cores.</pa>
</div><div id="footer"> </div>
Website powered by <a href="https://gohugo.io/">Hugo</a> <div>
<h2>Support for Kubernetes CRDs</h2>
<p>Validate ALL your Kubernetes resources with Kubeconform's CRD support</p>
</div>
<div>
<h2>Flexible</h2>
<p>With support for JSON, Junit, TAP output, and leveraging the easy-to-use Docker image, you can run Kubeconform in any CI system.</p>
</div> </div>
</div> </div>
<script defer src="/js/prism.js"></script> </div>
</body> </div><div id=footer>
</html> Website powered by <a href=https://gohugo.io/>Hugo</a>
</div>
</div>
<script defer src=/js/prism.js></script>
</body>
</html>

100
site/public/index.xml
View file

@ -1,95 +1,13 @@
<?xml version="1.0" encoding="utf-8" standalone="yes"?> <?xml version="1.0" encoding="utf-8" standalone="yes"?><rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom"><channel><title>Kubeconform - Fast Kubernetes manifests validation!</title><link>http://kubeconform.mandragor.org/</link><description>Recent content on Kubeconform - Fast Kubernetes manifests validation!</description><generator>Hugo -- gohugo.io</generator><language>en-us</language><lastBuildDate>Fri, 02 Jul 2021 00:00:00 +0000</lastBuildDate><atom:link href="http://kubeconform.mandragor.org/index.xml" rel="self" type="application/rss+xml"/><item><title>Overview</title><link>http://kubeconform.mandragor.org/docs/overview/</link><pubDate>Fri, 02 Jul 2021 00:00:00 +0000</pubDate><guid>http://kubeconform.mandragor.org/docs/overview/</guid><description>Kubeconform is a Kubernetes manifests validation tool, and checks whether your Kubernetes manifests are valid, according to Kubernetes resources definitions.
<rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom">
<channel>
<title>Kubeconform - Fast Kubernetes manifests validation!</title>
<link>http://kubeconform.mandragor.org/</link>
<description>Recent content on Kubeconform - Fast Kubernetes manifests validation!</description>
<generator>Hugo -- gohugo.io</generator>
<language>en-us</language>
<lastBuildDate>Fri, 02 Jul 2021 00:00:00 +0000</lastBuildDate><atom:link href="http://kubeconform.mandragor.org/index.xml" rel="self" type="application/rss+xml" />
<item>
<title>Overview</title>
<link>http://kubeconform.mandragor.org/docs/overview/</link>
<pubDate>Fri, 02 Jul 2021 00:00:00 +0000</pubDate>
<guid>http://kubeconform.mandragor.org/docs/overview/</guid>
<description>Kubeconform is a Kubernetes manifests validation tool. Build it into your CI to validate your Kubernetes configuration!
It is inspired by, contains code from and is designed to stay close to Kubeval, but with the following improvements: It is inspired by, contains code from and is designed to stay close to Kubeval, but with the following improvements:
high performance: will validate &amp;amp; download manifests over multiple routines, caching downloaded files in memory configurable list of remote, or local schemas locations, enabling validating Kubernetes custom resources (CRDs) and offline validation capabilities uses by default a self-updating fork of the schemas registry maintained by the kubernetes-json-schema project - which guarantees up-to-date schemas for all recent versions of Kubernetes.</description> high performance: will validate &amp;amp; download manifests over multiple routines, caching downloaded files in memory configurable list of remote, or local schemas locations, enabling validating Kubernetes custom resources (CRDs) and offline validation capabilities uses by default a self-updating fork of the schemas registry maintained by the kubernetes-json-schema project - which guarantees up-to-date schemas for all recent versions of Kubernetes.</description></item><item><title>Installation</title><link>http://kubeconform.mandragor.org/docs/installation/</link><pubDate>Fri, 02 Jul 2021 00:00:00 +0000</pubDate><guid>http://kubeconform.mandragor.org/docs/installation/</guid><description>Linux Download the latest release from our release page.
</item>
<item>
<title>Installation</title>
<link>http://kubeconform.mandragor.org/docs/installation/</link>
<pubDate>Fri, 02 Jul 2021 00:00:00 +0000</pubDate>
<guid>http://kubeconform.mandragor.org/docs/installation/</guid>
<description>Linux Download the latest release from our release page.
For example, for Linux on x86_64 architecture: 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 - &amp;&amp; \ sudo mv kubeconform /usr/local/bin/ MacOs Kubeconform is available to install using Homebrew: $ brew install kubeconform curl -L https://github.com/yannh/kubeconform/releases/latest/download/kubeconform-linux-amd64.tar.gz | tar xvzf - &amp;&amp; \ 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> 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 &amp;ldquo;default&amp;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.
</item> If the -schema-location value does not end with &amp;lsquo;.json&amp;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&amp;rsquo;s new Container Registry, ghcr.io. These images can be used directly in a Github Action, once logged in using a Github Token.
<item> 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.
<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&#39;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 &amp;ldquo;default&amp;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 &amp;lsquo;.json&amp;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&amp;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 &#34;${{ github.token }}&#34; | docker login https://ghcr.io -u ${GITHUB_ACTOR} --password-stdin - uses: actions/checkout@v2 - uses: docker://ghcr.io/yannh/kubeconform:master with: entrypoint: &#39;/kubeconform&#39; args: &#34;-summary -output json kubeconfigs/&#34; 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 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> Additional documentation on pkg.go.dev</description></item><item><title>About</title><link>http://kubeconform.mandragor.org/about/</link><pubDate>Fri, 02 Jul 2021 00:00:00 +0000</pubDate><guid>http://kubeconform.mandragor.org/about/</guid><description>Kubeconform is a Kubernetes manifests validation tool. Build it into your CI to validate your Kubernetes configuration!
</item>
<item>
<title>About</title>
<link>http://kubeconform.mandragor.org/about/</link>
<pubDate>Fri, 02 Jul 2021 00:00:00 +0000</pubDate>
<guid>http://kubeconform.mandragor.org/about/</guid>
<description>Kubeconform is a Kubernetes manifests validation tool. Build it into your CI to validate your Kubernetes configuration!
It is inspired by, contains code from and is designed to stay close to Kubeval, but with the following improvements: It is inspired by, contains code from and is designed to stay close to Kubeval, but with the following improvements:
high performance: will validate &amp;amp; download manifests over multiple routines, caching downloaded files in memory configurable list of remote, or local schemas locations, enabling validating Kubernetes custom resources (CRDs) and offline validation capabilities uses by default a self-updating fork of the schemas registry maintained by the kubernetes-json-schema project - which guarantees up-to-date schemas for all recent versions of Kubernetes.</description> high performance: will validate &amp;amp; download manifests over multiple routines, caching downloaded files in memory configurable list of remote, or local schemas locations, enabling validating Kubernetes custom resources (CRDs) and offline validation capabilities uses by default a self-updating fork of the schemas registry maintained by the kubernetes-json-schema project - which guarantees up-to-date schemas for all recent versions of Kubernetes.</description></item></channel></rss>
</item>
</channel>
</rss>

56
site/public/sitemap.xml
View file

@ -1,55 +1 @@
<?xml version="1.0" encoding="utf-8" standalone="yes"?> <?xml version="1.0" encoding="utf-8" standalone="yes"?><urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9" xmlns:xhtml="http://www.w3.org/1999/xhtml"><url><loc>http://kubeconform.mandragor.org/docs/overview/</loc><lastmod>2021-07-02T00:00:00+00:00</lastmod></url><url><loc>http://kubeconform.mandragor.org/docs/installation/</loc><lastmod>2021-07-02T00:00:00+00:00</lastmod></url><url><loc>http://kubeconform.mandragor.org/docs/usage/</loc><lastmod>2021-07-02T00:00:00+00:00</lastmod></url><url><loc>http://kubeconform.mandragor.org/docs/crd-support/</loc><lastmod>2021-07-02T00:00:00+00:00</lastmod></url><url><loc>http://kubeconform.mandragor.org/docs/json-schema-conversion/</loc><lastmod>2021-07-02T00:00:00+00:00</lastmod></url><url><loc>http://kubeconform.mandragor.org/docs/usage-as-github-action/</loc><lastmod>2021-07-02T00:00:00+00:00</lastmod></url><url><loc>http://kubeconform.mandragor.org/docs/using-as-a-go-module/</loc><lastmod>2021-07-02T00:00:00+00:00</lastmod></url><url><loc>http://kubeconform.mandragor.org/tags/about/</loc><lastmod>2021-07-02T00:00:00+00:00</lastmod></url><url><loc>http://kubeconform.mandragor.org/about/</loc><lastmod>2021-07-02T00:00:00+00:00</lastmod></url><url><loc>http://kubeconform.mandragor.org/docs/</loc><lastmod>2021-07-02T00:00:00+00:00</lastmod></url><url><loc>http://kubeconform.mandragor.org/tags/installation/</loc><lastmod>2021-07-02T00:00:00+00:00</lastmod></url><url><loc>http://kubeconform.mandragor.org/tags/kubeconform/</loc><lastmod>2021-07-02T00:00:00+00:00</lastmod></url><url><loc>http://kubeconform.mandragor.org/</loc><lastmod>2021-07-02T00:00:00+00:00</lastmod></url><url><loc>http://kubeconform.mandragor.org/tags/overview/</loc><lastmod>2021-07-02T00:00:00+00:00</lastmod></url><url><loc>http://kubeconform.mandragor.org/tags/</loc><lastmod>2021-07-02T00:00:00+00:00</lastmod></url><url><loc>http://kubeconform.mandragor.org/tags/usage/</loc><lastmod>2021-07-02T00:00:00+00:00</lastmod></url><url><loc>http://kubeconform.mandragor.org/categories/</loc></url></urlset>
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9"
xmlns:xhtml="http://www.w3.org/1999/xhtml">
<url>
<loc>http://kubeconform.mandragor.org/docs/overview/</loc>
<lastmod>2021-07-02T00:00:00+00:00</lastmod>
</url><url>
<loc>http://kubeconform.mandragor.org/docs/installation/</loc>
<lastmod>2021-07-02T00:00:00+00:00</lastmod>
</url><url>
<loc>http://kubeconform.mandragor.org/docs/usage/</loc>
<lastmod>2021-07-02T00:00:00+00:00</lastmod>
</url><url>
<loc>http://kubeconform.mandragor.org/docs/crd-support/</loc>
<lastmod>2021-07-02T00:00:00+00:00</lastmod>
</url><url>
<loc>http://kubeconform.mandragor.org/docs/json-schema-conversion/</loc>
<lastmod>2021-07-02T00:00:00+00:00</lastmod>
</url><url>
<loc>http://kubeconform.mandragor.org/docs/usage-as-github-action/</loc>
<lastmod>2021-07-02T00:00:00+00:00</lastmod>
</url><url>
<loc>http://kubeconform.mandragor.org/docs/using-as-a-go-module/</loc>
<lastmod>2021-07-02T00:00:00+00:00</lastmod>
</url><url>
<loc>http://kubeconform.mandragor.org/tags/about/</loc>
<lastmod>2021-07-02T00:00:00+00:00</lastmod>
</url><url>
<loc>http://kubeconform.mandragor.org/about/</loc>
<lastmod>2021-07-02T00:00:00+00:00</lastmod>
</url><url>
<loc>http://kubeconform.mandragor.org/docs/</loc>
<lastmod>2021-07-02T00:00:00+00:00</lastmod>
</url><url>
<loc>http://kubeconform.mandragor.org/tags/installation/</loc>
<lastmod>2021-07-02T00:00:00+00:00</lastmod>
</url><url>
<loc>http://kubeconform.mandragor.org/tags/kubeconform/</loc>
<lastmod>2021-07-02T00:00:00+00:00</lastmod>
</url><url>
<loc>http://kubeconform.mandragor.org/</loc>
<lastmod>2021-07-02T00:00:00+00:00</lastmod>
</url><url>
<loc>http://kubeconform.mandragor.org/tags/overview/</loc>
<lastmod>2021-07-02T00:00:00+00:00</lastmod>
</url><url>
<loc>http://kubeconform.mandragor.org/tags/</loc>
<lastmod>2021-07-02T00:00:00+00:00</lastmod>
</url><url>
<loc>http://kubeconform.mandragor.org/tags/usage/</loc>
<lastmod>2021-07-02T00:00:00+00:00</lastmod>
</url><url>
<loc>http://kubeconform.mandragor.org/categories/</loc>
</url>
</urlset>

23
site/public/tags/about/index.xml
View file

@ -1,22 +1,3 @@
<?xml version="1.0" encoding="utf-8" standalone="yes"?> <?xml version="1.0" encoding="utf-8" standalone="yes"?><rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom"><channel><title>About on Kubeconform - Fast Kubernetes manifests validation!</title><link>http://kubeconform.mandragor.org/tags/about/</link><description>Recent content in About on Kubeconform - Fast Kubernetes manifests validation!</description><generator>Hugo -- gohugo.io</generator><language>en-us</language><lastBuildDate>Fri, 02 Jul 2021 00:00:00 +0000</lastBuildDate><atom:link href="http://kubeconform.mandragor.org/tags/about/index.xml" rel="self" type="application/rss+xml"/><item><title>About</title><link>http://kubeconform.mandragor.org/about/</link><pubDate>Fri, 02 Jul 2021 00:00:00 +0000</pubDate><guid>http://kubeconform.mandragor.org/about/</guid><description>Kubeconform is a Kubernetes manifests validation tool. Build it into your CI to validate your Kubernetes configuration!
<rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom">
<channel>
<title>About on Kubeconform - Fast Kubernetes manifests validation!</title>
<link>http://kubeconform.mandragor.org/tags/about/</link>
<description>Recent content in About on Kubeconform - Fast Kubernetes manifests validation!</description>
<generator>Hugo -- gohugo.io</generator>
<language>en-us</language>
<lastBuildDate>Fri, 02 Jul 2021 00:00:00 +0000</lastBuildDate><atom:link href="http://kubeconform.mandragor.org/tags/about/index.xml" rel="self" type="application/rss+xml" />
<item>
<title>About</title>
<link>http://kubeconform.mandragor.org/about/</link>
<pubDate>Fri, 02 Jul 2021 00:00:00 +0000</pubDate>
<guid>http://kubeconform.mandragor.org/about/</guid>
<description>Kubeconform is a Kubernetes manifests validation tool. Build it into your CI to validate your Kubernetes configuration!
It is inspired by, contains code from and is designed to stay close to Kubeval, but with the following improvements: It is inspired by, contains code from and is designed to stay close to Kubeval, but with the following improvements:
high performance: will validate &amp;amp; download manifests over multiple routines, caching downloaded files in memory configurable list of remote, or local schemas locations, enabling validating Kubernetes custom resources (CRDs) and offline validation capabilities uses by default a self-updating fork of the schemas registry maintained by the kubernetes-json-schema project - which guarantees up-to-date schemas for all recent versions of Kubernetes.</description> high performance: will validate &amp;amp; download manifests over multiple routines, caching downloaded files in memory configurable list of remote, or local schemas locations, enabling validating Kubernetes custom resources (CRDs) and offline validation capabilities uses by default a self-updating fork of the schemas registry maintained by the kubernetes-json-schema project - which guarantees up-to-date schemas for all recent versions of Kubernetes.</description></item></channel></rss>
</item>
</channel>
</rss>

57
site/public/tags/index.xml
View file

@ -1,56 +1 @@
<?xml version="1.0" encoding="utf-8" standalone="yes"?> <?xml version="1.0" encoding="utf-8" standalone="yes"?><rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom"><channel><title>Tags on Kubeconform - Fast Kubernetes manifests validation!</title><link>http://kubeconform.mandragor.org/tags/</link><description>Recent content in Tags on Kubeconform - Fast Kubernetes manifests validation!</description><generator>Hugo -- gohugo.io</generator><language>en-us</language><lastBuildDate>Fri, 02 Jul 2021 00:00:00 +0000</lastBuildDate><atom:link href="http://kubeconform.mandragor.org/tags/index.xml" rel="self" type="application/rss+xml"/><item><title>About</title><link>http://kubeconform.mandragor.org/tags/about/</link><pubDate>Fri, 02 Jul 2021 00:00:00 +0000</pubDate><guid>http://kubeconform.mandragor.org/tags/about/</guid><description/></item><item><title>Installation</title><link>http://kubeconform.mandragor.org/tags/installation/</link><pubDate>Fri, 02 Jul 2021 00:00:00 +0000</pubDate><guid>http://kubeconform.mandragor.org/tags/installation/</guid><description/></item><item><title>Kubeconform</title><link>http://kubeconform.mandragor.org/tags/kubeconform/</link><pubDate>Fri, 02 Jul 2021 00:00:00 +0000</pubDate><guid>http://kubeconform.mandragor.org/tags/kubeconform/</guid><description/></item><item><title>Overview</title><link>http://kubeconform.mandragor.org/tags/overview/</link><pubDate>Fri, 02 Jul 2021 00:00:00 +0000</pubDate><guid>http://kubeconform.mandragor.org/tags/overview/</guid><description/></item><item><title>Usage</title><link>http://kubeconform.mandragor.org/tags/usage/</link><pubDate>Fri, 02 Jul 2021 00:00:00 +0000</pubDate><guid>http://kubeconform.mandragor.org/tags/usage/</guid><description/></item></channel></rss>
<rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom">
<channel>
<title>Tags on Kubeconform - Fast Kubernetes manifests validation!</title>
<link>http://kubeconform.mandragor.org/tags/</link>
<description>Recent content in Tags on Kubeconform - Fast Kubernetes manifests validation!</description>
<generator>Hugo -- gohugo.io</generator>
<language>en-us</language>
<lastBuildDate>Fri, 02 Jul 2021 00:00:00 +0000</lastBuildDate><atom:link href="http://kubeconform.mandragor.org/tags/index.xml" rel="self" type="application/rss+xml" />
<item>
<title>About</title>
<link>http://kubeconform.mandragor.org/tags/about/</link>
<pubDate>Fri, 02 Jul 2021 00:00:00 +0000</pubDate>
<guid>http://kubeconform.mandragor.org/tags/about/</guid>
<description></description>
</item>
<item>
<title>Installation</title>
<link>http://kubeconform.mandragor.org/tags/installation/</link>
<pubDate>Fri, 02 Jul 2021 00:00:00 +0000</pubDate>
<guid>http://kubeconform.mandragor.org/tags/installation/</guid>
<description></description>
</item>
<item>
<title>Kubeconform</title>
<link>http://kubeconform.mandragor.org/tags/kubeconform/</link>
<pubDate>Fri, 02 Jul 2021 00:00:00 +0000</pubDate>
<guid>http://kubeconform.mandragor.org/tags/kubeconform/</guid>
<description></description>
</item>
<item>
<title>Overview</title>
<link>http://kubeconform.mandragor.org/tags/overview/</link>
<pubDate>Fri, 02 Jul 2021 00:00:00 +0000</pubDate>
<guid>http://kubeconform.mandragor.org/tags/overview/</guid>
<description></description>
</item>
<item>
<title>Usage</title>
<link>http://kubeconform.mandragor.org/tags/usage/</link>
<pubDate>Fri, 02 Jul 2021 00:00:00 +0000</pubDate>
<guid>http://kubeconform.mandragor.org/tags/usage/</guid>
<description></description>
</item>
</channel>
</rss>

25
site/public/tags/installation/index.xml
View file

@ -1,23 +1,4 @@
<?xml version="1.0" encoding="utf-8" standalone="yes"?> <?xml version="1.0" encoding="utf-8" standalone="yes"?><rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom"><channel><title>Installation on Kubeconform - Fast Kubernetes manifests validation!</title><link>http://kubeconform.mandragor.org/tags/installation/</link><description>Recent content in Installation on Kubeconform - Fast Kubernetes manifests validation!</description><generator>Hugo -- gohugo.io</generator><language>en-us</language><lastBuildDate>Fri, 02 Jul 2021 00:00:00 +0000</lastBuildDate><atom:link href="http://kubeconform.mandragor.org/tags/installation/index.xml" rel="self" type="application/rss+xml"/><item><title>Installation</title><link>http://kubeconform.mandragor.org/docs/installation/</link><pubDate>Fri, 02 Jul 2021 00:00:00 +0000</pubDate><guid>http://kubeconform.mandragor.org/docs/installation/</guid><description>Linux Download the latest release from our release page.
<rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom">
<channel>
<title>Installation on Kubeconform - Fast Kubernetes manifests validation!</title>
<link>http://kubeconform.mandragor.org/tags/installation/</link>
<description>Recent content in Installation on Kubeconform - Fast Kubernetes manifests validation!</description>
<generator>Hugo -- gohugo.io</generator>
<language>en-us</language>
<lastBuildDate>Fri, 02 Jul 2021 00:00:00 +0000</lastBuildDate><atom:link href="http://kubeconform.mandragor.org/tags/installation/index.xml" rel="self" type="application/rss+xml" />
<item>
<title>Installation</title>
<link>http://kubeconform.mandragor.org/docs/installation/</link>
<pubDate>Fri, 02 Jul 2021 00:00:00 +0000</pubDate>
<guid>http://kubeconform.mandragor.org/docs/installation/</guid>
<description>Linux Download the latest release from our release page.
For example, for Linux on x86_64 architecture: 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 - &amp;&amp; \ sudo mv kubeconform /usr/local/bin/ MacOs Kubeconform is available to install using Homebrew: $ brew install kubeconform curl -L https://github.com/yannh/kubeconform/releases/latest/download/kubeconform-linux-amd64.tar.gz | tar xvzf - &amp;&amp; \ 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> Windows Download the latest release from our release page.</description></item></channel></rss>
</item>
</channel>
</rss>

100
site/public/tags/kubeconform/index.xml
View file

@ -1,95 +1,13 @@
<?xml version="1.0" encoding="utf-8" standalone="yes"?> <?xml version="1.0" encoding="utf-8" standalone="yes"?><rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom"><channel><title>Kubeconform on Kubeconform - Fast Kubernetes manifests validation!</title><link>http://kubeconform.mandragor.org/tags/kubeconform/</link><description>Recent content in Kubeconform on Kubeconform - Fast Kubernetes manifests validation!</description><generator>Hugo -- gohugo.io</generator><language>en-us</language><lastBuildDate>Fri, 02 Jul 2021 00:00:00 +0000</lastBuildDate><atom:link href="http://kubeconform.mandragor.org/tags/kubeconform/index.xml" rel="self" type="application/rss+xml"/><item><title>Overview</title><link>http://kubeconform.mandragor.org/docs/overview/</link><pubDate>Fri, 02 Jul 2021 00:00:00 +0000</pubDate><guid>http://kubeconform.mandragor.org/docs/overview/</guid><description>Kubeconform is a Kubernetes manifests validation tool, and checks whether your Kubernetes manifests are valid, according to Kubernetes resources definitions.
<rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom">
<channel>
<title>Kubeconform on Kubeconform - Fast Kubernetes manifests validation!</title>
<link>http://kubeconform.mandragor.org/tags/kubeconform/</link>
<description>Recent content in Kubeconform on Kubeconform - Fast Kubernetes manifests validation!</description>
<generator>Hugo -- gohugo.io</generator>
<language>en-us</language>
<lastBuildDate>Fri, 02 Jul 2021 00:00:00 +0000</lastBuildDate><atom:link href="http://kubeconform.mandragor.org/tags/kubeconform/index.xml" rel="self" type="application/rss+xml" />
<item>
<title>Overview</title>
<link>http://kubeconform.mandragor.org/docs/overview/</link>
<pubDate>Fri, 02 Jul 2021 00:00:00 +0000</pubDate>
<guid>http://kubeconform.mandragor.org/docs/overview/</guid>
<description>Kubeconform is a Kubernetes manifests validation tool. Build it into your CI to validate your Kubernetes configuration!
It is inspired by, contains code from and is designed to stay close to Kubeval, but with the following improvements: It is inspired by, contains code from and is designed to stay close to Kubeval, but with the following improvements:
high performance: will validate &amp;amp; download manifests over multiple routines, caching downloaded files in memory configurable list of remote, or local schemas locations, enabling validating Kubernetes custom resources (CRDs) and offline validation capabilities uses by default a self-updating fork of the schemas registry maintained by the kubernetes-json-schema project - which guarantees up-to-date schemas for all recent versions of Kubernetes.</description> high performance: will validate &amp;amp; download manifests over multiple routines, caching downloaded files in memory configurable list of remote, or local schemas locations, enabling validating Kubernetes custom resources (CRDs) and offline validation capabilities uses by default a self-updating fork of the schemas registry maintained by the kubernetes-json-schema project - which guarantees up-to-date schemas for all recent versions of Kubernetes.</description></item><item><title>Installation</title><link>http://kubeconform.mandragor.org/docs/installation/</link><pubDate>Fri, 02 Jul 2021 00:00:00 +0000</pubDate><guid>http://kubeconform.mandragor.org/docs/installation/</guid><description>Linux Download the latest release from our release page.
</item>
<item>
<title>Installation</title>
<link>http://kubeconform.mandragor.org/docs/installation/</link>
<pubDate>Fri, 02 Jul 2021 00:00:00 +0000</pubDate>
<guid>http://kubeconform.mandragor.org/docs/installation/</guid>
<description>Linux Download the latest release from our release page.
For example, for Linux on x86_64 architecture: 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 - &amp;&amp; \ sudo mv kubeconform /usr/local/bin/ MacOs Kubeconform is available to install using Homebrew: $ brew install kubeconform curl -L https://github.com/yannh/kubeconform/releases/latest/download/kubeconform-linux-amd64.tar.gz | tar xvzf - &amp;&amp; \ 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> 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 &amp;ldquo;default&amp;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.
</item> If the -schema-location value does not end with &amp;lsquo;.json&amp;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&amp;rsquo;s new Container Registry, ghcr.io. These images can be used directly in a Github Action, once logged in using a Github Token.
<item> 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.
<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&#39;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 &amp;ldquo;default&amp;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 &amp;lsquo;.json&amp;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&amp;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 &#34;${{ github.token }}&#34; | docker login https://ghcr.io -u ${GITHUB_ACTOR} --password-stdin - uses: actions/checkout@v2 - uses: docker://ghcr.io/yannh/kubeconform:master with: entrypoint: &#39;/kubeconform&#39; args: &#34;-summary -output json kubeconfigs/&#34; 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 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> Additional documentation on pkg.go.dev</description></item><item><title>About</title><link>http://kubeconform.mandragor.org/about/</link><pubDate>Fri, 02 Jul 2021 00:00:00 +0000</pubDate><guid>http://kubeconform.mandragor.org/about/</guid><description>Kubeconform is a Kubernetes manifests validation tool. Build it into your CI to validate your Kubernetes configuration!
</item>
<item>
<title>About</title>
<link>http://kubeconform.mandragor.org/about/</link>
<pubDate>Fri, 02 Jul 2021 00:00:00 +0000</pubDate>
<guid>http://kubeconform.mandragor.org/about/</guid>
<description>Kubeconform is a Kubernetes manifests validation tool. Build it into your CI to validate your Kubernetes configuration!
It is inspired by, contains code from and is designed to stay close to Kubeval, but with the following improvements: It is inspired by, contains code from and is designed to stay close to Kubeval, but with the following improvements:
high performance: will validate &amp;amp; download manifests over multiple routines, caching downloaded files in memory configurable list of remote, or local schemas locations, enabling validating Kubernetes custom resources (CRDs) and offline validation capabilities uses by default a self-updating fork of the schemas registry maintained by the kubernetes-json-schema project - which guarantees up-to-date schemas for all recent versions of Kubernetes.</description> high performance: will validate &amp;amp; download manifests over multiple routines, caching downloaded files in memory configurable list of remote, or local schemas locations, enabling validating Kubernetes custom resources (CRDs) and offline validation capabilities uses by default a self-updating fork of the schemas registry maintained by the kubernetes-json-schema project - which guarantees up-to-date schemas for all recent versions of Kubernetes.</description></item></channel></rss>
</item>
</channel>
</rss>

65
site/public/tags/usage/index.xml
View file

@ -1,61 +1,6 @@
<?xml version="1.0" encoding="utf-8" standalone="yes"?> <?xml version="1.0" encoding="utf-8" standalone="yes"?><rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom"><channel><title>Usage on Kubeconform - Fast Kubernetes manifests validation!</title><link>http://kubeconform.mandragor.org/tags/usage/</link><description>Recent content in Usage on Kubeconform - Fast Kubernetes manifests validation!</description><generator>Hugo -- gohugo.io</generator><language>en-us</language><lastBuildDate>Fri, 02 Jul 2021 00:00:00 +0000</lastBuildDate><atom:link href="http://kubeconform.mandragor.org/tags/usage/index.xml" rel="self" type="application/rss+xml"/><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 &amp;ldquo;default&amp;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.
<rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom"> If the -schema-location value does not end with &amp;lsquo;.json&amp;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:
<channel> #!/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&amp;rsquo;s new Container Registry, ghcr.io. These images can be used directly in a Github Action, once logged in using a Github Token.
<title>Usage on Kubeconform - Fast Kubernetes manifests validation!</title> 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.
<link>http://kubeconform.mandragor.org/tags/usage/</link>
<description>Recent content in Usage on Kubeconform - Fast Kubernetes manifests validation!</description>
<generator>Hugo -- gohugo.io</generator>
<language>en-us</language>
<lastBuildDate>Fri, 02 Jul 2021 00:00:00 +0000</lastBuildDate><atom:link href="http://kubeconform.mandragor.org/tags/usage/index.xml" rel="self" type="application/rss+xml" />
<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&#39;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 &amp;ldquo;default&amp;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 &amp;lsquo;.json&amp;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&amp;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 &#34;${{ github.token }}&#34; | docker login https://ghcr.io -u ${GITHUB_ACTOR} --password-stdin - uses: actions/checkout@v2 - uses: docker://ghcr.io/yannh/kubeconform:master with: entrypoint: &#39;/kubeconform&#39; args: &#34;-summary -output json kubeconfigs/&#34; 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 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> Additional documentation on pkg.go.dev</description></item></channel></rss>
</item>
</channel>
</rss>

8
site/themes/kubeconform/layouts/_default/single.html
View file

@ -3,9 +3,13 @@
<div class="navig"> <div class="navig">
{{ with .NextInSection }} <!-- Prev & Next are switched in this version of Hugo --> {{ with .NextInSection }} <!-- Prev & Next are switched in this version of Hugo -->
<a href="{{ .Permalink }}" id="prev">&lt; {{ .Title }}</a> <a href="{{ .Permalink }}" id="prev">&lt; {{ .Title }}</a>
{{ else }}
<a href="#" id="prev"></a>
{{ end }} {{ end }}
{{ with .PrevInSection }} {{ with .PrevInSection }}
<a href="{{ .Permalink }}" id="next">{{ .Title }} &gt;</a> <a href="{{ .Permalink }}" id="next">{{ .Title }} &gt;</a>
{{ else }}
<a href="#" id="prev"></a>
{{ end }} {{ end }}
</div> </div>
@ -17,9 +21,13 @@
<div class="navig"> <div class="navig">
{{ with .NextInSection }} <!-- Prev & Next are switched in this version of Hugo --> {{ with .NextInSection }} <!-- Prev & Next are switched in this version of Hugo -->
<a href="{{ .Permalink }}" id="prev">&lt; {{ .Title }}</a> <a href="{{ .Permalink }}" id="prev">&lt; {{ .Title }}</a>
{{ else }}
<a href="#" id="prev"></a>
{{ end }} {{ end }}
{{ with .PrevInSection }} {{ with .PrevInSection }}
<a href="{{ .Permalink }}" id="next">{{ .Title }} &gt;</a> <a href="{{ .Permalink }}" id="next">{{ .Title }} &gt;</a>
{{ else }}
<a href="#" id="prev"></a>
{{ end }} {{ end }}
</div> </div>

1
site/themes/kubeconform/layouts/partials/header.html
View file

@ -1,6 +1,7 @@
<div id="header"> <div id="header">
<ul id="navigation"> <ul id="navigation">
<li><a href="/about">About</a></li> <li><a href="/about">About</a></li>
<li><a href="https://github.com/yannh/kubeconform/">Github</a></li>
<li><a href="/docs/installation/">Docs</a></li> <li><a href="/docs/installation/">Docs</a></li>
<li><a href="/">Home</a></li> <li><a href="/">Home</a></li>
</ul> </ul>

23
site/themes/kubeconform/static/css/style.css
View file

@ -63,11 +63,6 @@ hr {
padding: 0.5em 0 0.5em 0em; padding: 0.5em 0 0.5em 0em;
} }
#menu {
background-color: #ddd;
padding: 1em
}
#content { #content {
display:flex; display:flex;
} }
@ -75,9 +70,25 @@ hr {
#menu { #menu {
flex: 15; flex: 15;
min-width: 15%; min-width: 15%;
padding: 2em background-color: #ddd;
padding: 2em;
} }
#menu li {
line-height: 1.9rem;
padding-bottom: 0.6rem;
}
#menu li::marker {
font-size: smaller;
}
#menu li a:hover {
text-decoration: underline;
}
#main { #main {
flex: 85; flex: 85;
min-width: 0; min-width: 0;