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

Update website

Browse source
This commit is contained in:
Yann Hamon 2021-12-19 23:46:04 +01:00 committed by Yann
parent 2b3139b1db
commit d10c9bde67
24 changed files with 235 additions and 129 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
.github/workflows/site.yml vendored
View file

@ -1,6 +1,8 @@
on:
workflow_dispatch:
push:
paths:
- 'site/**'
branches:
- master

2
site/content/docs/crd-support.md
View file

@ -3,7 +3,7 @@ title: "Custom Resources support"
date: 2021-07-02T00:00:00Z
draft: false
tags: ["Kubeconform", "Usage"]
weight: 3
weight: 4
---
When the `-schema-location` parameter is not used, or set to "default", kubeconform will default to downloading

8
site/content/docs/installation.md
View file

@ -3,7 +3,7 @@ title: "Installation"
date: 2021-07-02T00:00:00Z
draft: false
tags: ["Kubeconform", "Installation"]
weight: 1
weight: 2
---
## Linux
@ -25,8 +25,4 @@ Kubeconform is available to install using [Homebrew](https://brew.sh/):
## Windows
Download the latest release from our [release page](https://github.com/yannh/kubeconform/releases).
You can also download the latest version from the [release page](https://github.com/yannh/kubeconform/releases).
Download the latest release from our [release page](https://github.com/yannh/kubeconform/releases).

3
site/content/docs/json-schema-conversion.md
View file

@ -1,8 +1,9 @@
---
title: "Conversion of CRD to JSON Schema"
title: "OpenAPI to JSON Schema conversion"
date: 2021-07-02T00:00:00Z
draft: false
tags: ["Kubeconform", "Usage"]
weight: 5
---
Kubeconform uses JSON schemas to validate Kubernetes resources. For custom resources, the CustomResourceDefinition

48
site/content/docs/overview.md Normal file
View file

@ -0,0 +1,48 @@
---
title: "Overview"
date: 2021-07-02T00:00:00Z
draft: false
tags: ["Kubeconform", "Overview"]
weight: 1
---
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](https://github.com/instrumenta/kubeval), but with the following improvements:
* **high performance**: will validate & 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](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
up-to-date **schemas for all recent versions of Kubernetes**.
### A small overview of Kubernetes manifest validation
Kubernetes's API is described using the [OpenAPI (formerly swagger) specification](https://www.openapis.org),
in a [file](https://github.com/kubernetes/kubernetes/blob/master/api/openapi-spec/swagger.json) checked into
the main Kubernetes repository.
Because of the state of the tooling to perform validation against OpenAPI schemas, projects usually convert
the OpenAPI schemas to [JSON schemas](https://json-schema.org/) first. Kubeval relies on
[instrumenta/OpenApi2JsonSchema](https://github.com/instrumenta/openapi2jsonschema) to convert Kubernetes' Swagger file
and break it down into multiple JSON schemas, stored in github at
[instrumenta/kubernetes-json-schema](https://github.com/instrumenta/kubernetes-json-schema) and published on
[kubernetesjsonschema.dev](https://kubernetesjsonschema.dev/).
Kubeconform relies on [a fork of kubernetes-json-schema](https://github.com/yannh/kubernetes-json-schema/)
that is more aggressively kept up-to-date, and contains schemas for all recent versions of Kubernetes.
### Limits of Kubeconform validation
Kubeconform, similarly to kubeval, only validates manifests using the OpenAPI specifications. In some
cases, the Kubernetes controllers might perform additional validation - so that manifests passing kubeval
validation would still error when being deployed. See for example these bugs against kubeval:
[#253](https://github.com/instrumenta/kubeval/issues/253)
[#256](https://github.com/instrumenta/kubeval/issues/256)
[#257](https://github.com/instrumenta/kubeval/issues/257)
[#259](https://github.com/instrumenta/kubeval/issues/259). The validation logic mentioned in these
bug reports is not part of Kubernetes' OpenAPI spec, and therefore kubeconform/kubeval will not detect the
configuration errors.

2
site/content/docs/usage-as-github-action.md
View file

@ -3,7 +3,7 @@ title: "Github Action"
date: 2021-07-02T00:00:00Z
draft: false
tags: ["Kubeconform", "Usage"]
weight: 4
weight: 6
---
Kubeconform is publishes Docker Images to Github's new Container Registry, ghcr.io. These images

2
site/content/docs/usage.md
View file

@ -3,7 +3,7 @@ title: "Usage"
date: 2021-07-02T00:00:00Z
draft: false
tags: ["Kubeconform", "Usage"]
weight: 2
weight: 3
---
{{< prism >}}$ ./bin/kubeconform -h

2
site/content/docs/using-as-a-go-module.md
View file

@ -3,7 +3,7 @@ title: "Kubeconform as a Go module"
date: 2021-07-02T00:00:00Z
draft: false
tags: ["Kubeconform", "Usage"]
weight: 5
weight: 7
---
**Warning**: This is a work-in-progress, the interface is not yet considered stable. Feedback is encouraged.

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

@ -9,13 +9,13 @@ hr { border-color: #ddd; }
}
/* Font sizes */
body { font-size: 1.2rem; line-height: 1.7rem; text-size-adjust: 100%; }
h1 { font-size: 2.3rem; line-height: 3.2rem; font-weight: 400 }
h2 { font-size: 1.8rem; line-height: 2.3rem; font-weight: 400 }
h3 { font-size: 1.5rem; line-height: 1.8rem; font-weight: 300 }
body { font-size: 1.4rem; line-height: 1.9rem; text-size-adjust: 100%; }
h1 { font-size: 2.7rem; line-height: 3.8rem; font-weight: 400 }
h2 { font-size: 2rem; line-height: 2.5rem; font-weight: 400 }
h3 { font-size: 1.7rem; line-height: 2rem; font-weight: 300 }
#header h1 { font-size: 3rem; line-height: 3.3rem; font-weight: 500; margin-top: 0.2em; margin-left: 30px }
#header h2 { font-size: 1.3rem; line-height: 1.5rem; font-weight: 300; font-style: italic; margin: 0 0 0.5em 30px}
#header h1 { font-size: 4rem; line-height: 4.5rem; font-weight: 500; margin-top: 0.2em; margin-left: 30px }
#header h2 { font-size: 1.7rem; line-height: 2.2rem; font-weight: 300; font-style: italic; margin: 0 0 0.5em 30px}
/* We default all margins/paddings to 0 */
* { margin: 0; padding: 0 }
@ -131,7 +131,7 @@ pre {
#motto {
text-align: center;
font-style: italic;
font-size: 1.1em;
font-size: 1.4em;
margin: 2em auto 2em auto;
}
@ -155,13 +155,13 @@ pre {
}
#kc-pros h2 {
font-size: 1.2em;
font-size: 1.4em;
line-height: 1.2em;
padding: 0 5% 0.3em 5%;
}
#kc-pros p {
font-size: 0.9em;
font-size: 1.1em;
padding: 0 5% 2em 5%;
}

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

@ -17,27 +17,29 @@
</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>
<li><a href="http://kubeconform.mandragor.org/docs/json-schema-conversion/">Conversion of CRD to JSON Schema</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="http://kubeconform.mandragor.org/docs/usage/" id="prev">&lt; Usage</a>
<a href="http://kubeconform.mandragor.org/docs/usage/" id="next">Usage &gt;</a>
<a href="http://kubeconform.mandragor.org/docs/json-schema-conversion/" id="next">OpenAPI to JSON Schema conversion &gt;</a>
</div>
@ -84,11 +86,11 @@ Summary: 1 resource found in 1 file - Valid: 1, Invalid: 0, Errors: 0 Skipped: 0
</div>
<div class="navig">
<a href="http://kubeconform.mandragor.org/docs/usage-as-github-action/" id="prev">&lt; Github Action</a>
<a href="http://kubeconform.mandragor.org/docs/usage/" id="prev">&lt; Usage</a>
<a href="http://kubeconform.mandragor.org/docs/usage/" id="next">Usage &gt;</a>
<a href="http://kubeconform.mandragor.org/docs/json-schema-conversion/" id="next">OpenAPI to JSON Schema conversion &gt;</a>
</div>

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

@ -7,6 +7,17 @@
<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:
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>
@ -16,8 +27,7 @@
<description>Linux Download the latest release from our release page.
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
Windows Download the latest release from our release page.
You can also download the latest version from the release page.</description>
Windows Download the latest release from our release page.</description>
</item>
<item>
@ -39,6 +49,16 @@ You can also download the latest version from the release page.</description>
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>
@ -60,15 +80,5 @@ Kubeconform contains a package that can be used as a library. An example of usag
Additional documentation on pkg.go.dev</description>
</item>
<item>
<title>Conversion of CRD to JSON Schema</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>
</channel>
</rss>

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

@ -17,25 +17,29 @@
</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>
<li><a href="http://kubeconform.mandragor.org/docs/json-schema-conversion/">Conversion of CRD to JSON Schema</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="prev">&lt; Usage</a>
<a href="http://kubeconform.mandragor.org/docs/usage/" id="next">Usage &gt;</a>
</div>
@ -55,14 +59,15 @@ sudo mv kubeconform /usr/local/bin/
</code></pre></p>
<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>You can also download the latest version from the <a href="https://github.com/yannh/kubeconform/releases">release page</a>.</p>
</div>
<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="prev">&lt; Usage</a>
<a href="http://kubeconform.mandragor.org/docs/usage/" id="next">Usage &gt;</a>
</div>

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

@ -3,7 +3,7 @@
<meta charset="utf-8">
<meta name="author" content="Yann Hamon">
<link rel="stylesheet" type="text/css" href="/css/style.css"><link rel="stylesheet" type="text/css" href="/css/prism.css">
<title>Kubeconform - Fast Kubernetes manifests validation! | Conversion of CRD to JSON Schema</title>
<title>Kubeconform - Fast Kubernetes manifests validation! | OpenAPI to JSON Schema conversion</title>
</head>
<body>
<div id="main-container"><div id="header">
@ -17,30 +17,34 @@
</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>
<li><a href="http://kubeconform.mandragor.org/docs/json-schema-conversion/">Conversion of CRD to JSON Schema</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/using-as-a-go-module/" id="next">Kubeconform as a Go module &gt;</a>
<a href="http://kubeconform.mandragor.org/docs/usage-as-github-action/" id="next">Github Action &gt;</a>
</div>
<div id="content-text">
<h1>Conversion of CRD to JSON Schema</h1>
<h1>OpenAPI to JSON Schema conversion</h1>
<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
to JSON schema. Here is an example how to use it:</p>
@ -60,9 +64,11 @@ JSON schema written to trainingjob-sagemaker-v1.json
</div>
<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/using-as-a-go-module/" id="next">Kubeconform as a Go module &gt;</a>
<a href="http://kubeconform.mandragor.org/docs/usage-as-github-action/" id="next">Github Action &gt;</a>
</div>

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

@ -17,27 +17,29 @@
</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>
<li><a href="http://kubeconform.mandragor.org/docs/json-schema-conversion/">Conversion of CRD to JSON Schema</a></li>
</ul>
<div id="main">
<div class="navig">
<a href="http://kubeconform.mandragor.org/docs/using-as-a-go-module/" id="prev">&lt; 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/crd-support/" id="next">Custom Resources support &gt;</a>
<a href="http://kubeconform.mandragor.org/docs/using-as-a-go-module/" id="next">Kubeconform as a Go module &gt;</a>
</div>
@ -69,11 +71,11 @@ case, I might publish the Docker image to a different platform.</p>
</div>
<div class="navig">
<a href="http://kubeconform.mandragor.org/docs/using-as-a-go-module/" id="prev">&lt; 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/crd-support/" id="next">Custom Resources support &gt;</a>
<a href="http://kubeconform.mandragor.org/docs/using-as-a-go-module/" id="next">Kubeconform as a Go module &gt;</a>
</div>

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

@ -17,27 +17,29 @@
</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>
<li><a href="http://kubeconform.mandragor.org/docs/json-schema-conversion/">Conversion of CRD to JSON Schema</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/installation/" id="prev">&lt; Installation</a>
<a href="http://kubeconform.mandragor.org/docs/installation/" id="next">Installation &gt;</a>
<a href="http://kubeconform.mandragor.org/docs/crd-support/" id="next">Custom Resources support &gt;</a>
</div>
@ -125,11 +127,11 @@ Summary: 65 resources found in 34 files - Valid: 55, Invalid: 2, Errors: 8 Skipp
</div>
<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/installation/" id="prev">&lt; Installation</a>
<a href="http://kubeconform.mandragor.org/docs/installation/" id="next">Installation &gt;</a>
<a href="http://kubeconform.mandragor.org/docs/crd-support/" id="next">Custom Resources support &gt;</a>
</div>

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

@ -17,27 +17,27 @@
</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>
<li><a href="http://kubeconform.mandragor.org/docs/json-schema-conversion/">Conversion of CRD to JSON Schema</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="http://kubeconform.mandragor.org/docs/json-schema-conversion/" id="prev">&lt; Conversion of CRD to JSON Schema</a>
<a href="http://kubeconform.mandragor.org/docs/usage-as-github-action/" id="next">Github Action &gt;</a>
</div>
@ -51,11 +51,9 @@ An example of usage can be found in <a href="https://github.com/yannh/kubeconfor
</div>
<div class="navig">
<a href="http://kubeconform.mandragor.org/docs/usage-as-github-action/" id="prev">&lt; Github Action</a>
<a href="http://kubeconform.mandragor.org/docs/json-schema-conversion/" id="prev">&lt; Conversion of CRD to JSON Schema</a>
<a href="http://kubeconform.mandragor.org/docs/usage-as-github-action/" id="next">Github Action &gt;</a>
</div>

34
site/public/index.xml
View file

@ -7,6 +7,17 @@
<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:
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>
@ -16,8 +27,7 @@
<description>Linux Download the latest release from our release page.
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
Windows Download the latest release from our release page.
You can also download the latest version from the release page.</description>
Windows Download the latest release from our release page.</description>
</item>
<item>
@ -39,6 +49,16 @@ You can also download the latest version from the release page.</description>
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>
@ -71,15 +91,5 @@ It is inspired by, contains code from and is designed to stay close to Kubeval,
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>Conversion of CRD to JSON Schema</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>
</channel>
</rss>

12
site/public/sitemap.xml
View file

@ -2,6 +2,9 @@
<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>
@ -10,6 +13,9 @@
</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>
@ -22,9 +28,6 @@
</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/json-schema-conversion/</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>
@ -37,6 +40,9 @@
</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>

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

@ -34,6 +34,15 @@
<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>

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

@ -16,8 +16,7 @@
<description>Linux Download the latest release from our release page.
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
Windows Download the latest release from our release page.
You can also download the latest version from the release page.</description>
Windows Download the latest release from our release page.</description>
</item>
</channel>

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

@ -7,6 +7,17 @@
<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:
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>
@ -16,8 +27,7 @@
<description>Linux Download the latest release from our release page.
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
Windows Download the latest release from our release page.
You can also download the latest version from the release page.</description>
Windows Download the latest release from our release page.</description>
</item>
<item>
@ -39,6 +49,16 @@ You can also download the latest version from the release page.</description>
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>
@ -71,15 +91,5 @@ It is inspired by, contains code from and is designed to stay close to Kubeval,
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>Conversion of CRD to JSON Schema</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>
</channel>
</rss>

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

@ -26,6 +26,16 @@
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>
@ -47,15 +57,5 @@ Kubeconform contains a package that can be used as a library. An example of usag
Additional documentation on pkg.go.dev</description>
</item>
<item>
<title>Conversion of CRD to JSON Schema</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>
</channel>
</rss>

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

@ -1,10 +1,10 @@
{{ define "main" }}
<div class="navig">
{{ with .PrevInSection }}
{{ with .NextInSection }} <!-- Prev & Next are switched in this version of Hugo -->
<a href="{{ .Permalink }}" id="prev">&lt; {{ .Title }}</a>
{{ end }}
{{ with .NextInSection }}
{{ with .PrevInSection }}
<a href="{{ .Permalink }}" id="next">{{ .Title }} &gt;</a>
{{ end }}
</div>
@ -15,10 +15,10 @@
</div>
<div class="navig">
{{ with .PrevInSection }}
{{ with .NextInSection }} <!-- Prev & Next are switched in this version of Hugo -->
<a href="{{ .Permalink }}" id="prev">&lt; {{ .Title }}</a>
{{ end }}
{{ with .NextInSection }}
{{ with .PrevInSection }}
<a href="{{ .Permalink }}" id="next">{{ .Title }} &gt;</a>
{{ end }}
</div>

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

@ -9,13 +9,13 @@ hr { border-color: #ddd; }
}
/* Font sizes */
body { font-size: 1.2rem; line-height: 1.7rem; text-size-adjust: 100%; }
h1 { font-size: 2.3rem; line-height: 3.2rem; font-weight: 400 }
h2 { font-size: 1.8rem; line-height: 2.3rem; font-weight: 400 }
h3 { font-size: 1.5rem; line-height: 1.8rem; font-weight: 300 }
body { font-size: 1.4rem; line-height: 1.9rem; text-size-adjust: 100%; }
h1 { font-size: 2.7rem; line-height: 3.8rem; font-weight: 400 }
h2 { font-size: 2rem; line-height: 2.5rem; font-weight: 400 }
h3 { font-size: 1.7rem; line-height: 2rem; font-weight: 300 }
#header h1 { font-size: 3rem; line-height: 3.3rem; font-weight: 500; margin-top: 0.2em; margin-left: 30px }
#header h2 { font-size: 1.3rem; line-height: 1.5rem; font-weight: 300; font-style: italic; margin: 0 0 0.5em 30px}
#header h1 { font-size: 4rem; line-height: 4.5rem; font-weight: 500; margin-top: 0.2em; margin-left: 30px }
#header h2 { font-size: 1.7rem; line-height: 2.2rem; font-weight: 300; font-style: italic; margin: 0 0 0.5em 30px}
/* We default all margins/paddings to 0 */
* { margin: 0; padding: 0 }
@ -131,7 +131,7 @@ pre {
#motto {
text-align: center;
font-style: italic;
font-size: 1.1em;
font-size: 1.4em;
margin: 2em auto 2em auto;
}
@ -155,13 +155,13 @@ pre {
}
#kc-pros h2 {
font-size: 1.2em;
font-size: 1.4em;
line-height: 1.2em;
padding: 0 5% 0.3em 5%;
}
#kc-pros p {
font-size: 0.9em;
font-size: 1.1em;
padding: 0 5% 2em 5%;
}