Kubeconform

https://github.com/yannh/kubeconform
Admin
Kubeconform is a fast Kubernetes manifest validation tool that validates manifests against...
Tokens:11,639
Snippets:162
Trust Score:9
License:Apache-2.0
Update:3 months ago
Show doc for...
Tokens:
Raw
### Install and Import YAML Library

Source: https://github.com/yannh/kubeconform/blob/master/vendor/sigs.k8s.io/yaml/README.md

Install the library using go get and import it into your Go projects.

```bash
go get sigs.k8s.io/yaml
```

```go
import "sigs.k8s.io/yaml"
```

--------------------------------

### Install jsonschema CLI

Source: https://github.com/yannh/kubeconform/blob/master/vendor/github.com/santhosh-tekuri/jsonschema/v6/README.md

Install the jsonschema command-line tool (jv) using go install. The CLI is versioned independently.

```bash
go install github.com/santhosh-tekuri/jsonschema/cmd/jv@latest
```

--------------------------------

### Install Kubeconform with Homebrew

Source: https://github.com/yannh/kubeconform/blob/master/Readme.md

Use this command if you are a Homebrew user to install Kubeconform.

```bash
$ brew install kubeconform
```

--------------------------------

### Install Kubeconform on Linux

Source: https://github.com/yannh/kubeconform/blob/master/site/public/docs/installation/index.html

Download the latest release for Linux x86_64, extract it, and move the binary to /usr/local/bin.

```bash
curl -L https://github.com/yannh/kubeconform/releases/latest/download/kubeconform-linux-amd64.tar.gz | tar xvzf - && \
    sudo mv kubeconform /usr/local/bin/
```

--------------------------------

### Install Kubeconform with Go Modules (Latest Version)

Source: https://github.com/yannh/kubeconform/blob/master/Readme.md

Install the latest version of Kubeconform using Go's package manager.

```bash
# Latest version
$ go install github.com/yannh/kubeconform/cmd/kubeconform@latest
```

--------------------------------

### Install Kubeconform with Go Modules (Specific Version)

Source: https://github.com/yannh/kubeconform/blob/master/Readme.md

Install a specific version of Kubeconform using Go's package manager.

```bash
# With a specific version tag
$ go install github.com/yannh/kubeconform/cmd/kubeconform@v0.4.13
```

--------------------------------

### Install Kubeconform with Winget

Source: https://github.com/yannh/kubeconform/blob/master/Readme.md

Use this command if you are a Windows user to install Kubeconform via winget.

```cmd
winget install YannHamon.kubeconform
```

--------------------------------

### Install Kubeconform on macOS using Homebrew

Source: https://github.com/yannh/kubeconform/blob/master/site/public/docs/installation/index.html

Install Kubeconform using the Homebrew package manager on macOS.

```bash
$ brew install kubeconform
```

--------------------------------

### Basic GET Request with go-retryablehttp

Source: https://github.com/yannh/kubeconform/blob/master/vendor/github.com/hashicorp/go-retryablehttp/README.md

Demonstrates a simple GET request using the retryablehttp package. The call blocks and retries with exponential backoff if the request fails.

```go
resp, err := retryablehttp.Get("/foo")
if err != nil {
    panic(err)
}
```

--------------------------------

### Go YAML Encoding and Decoding Example

Source: https://github.com/yannh/kubeconform/blob/master/openapi2jsonschema-go/vendor/gopkg.in/yaml.v3/README.md

Demonstrates how to unmarshal YAML data into a Go struct and a map, and then marshal them back into YAML. Ensure struct fields are exported for unmarshalling.

```Go
package main

import (
        "fmt"
        "log"

        "gopkg.in/yaml.v3"
)

var data = `
a: Easy!
b:
  c: 2
  d: [3, 4]
`

// Note: struct fields must be public in order for unmarshal to
// correctly populate the data.
type T struct {
        A string
        B struct {
                RenamedC int   `yaml:"c"`
                D        []int `yaml:",flow"`
        }
}

func main() {
        t := T{}
    
        err := yaml.Unmarshal([]byte(data), &t)
        if err != nil {
                log.Fatalf("error: %v", err)
        }
        fmt.Printf("--- t:\n%v\n\n", t)
    
        d, err := yaml.Marshal(&t)
        if err != nil {
                log.Fatalf("error: %v", err)
        }
        fmt.Printf("--- t dump:\n%s\n\n", string(d))
    
        m := make(map[interface{}]interface{})
    
        err = yaml.Unmarshal([]byte(data), &m)
        if err != nil {
                log.Fatalf("error: %v", err)
        }
        fmt.Printf("--- m:\n%v\n\n", m)
    
        d, err = yaml.Marshal(&m)
        if err != nil {
                log.Fatalf("error: %v", err)
        }
        fmt.Printf("--- m dump:\n%s\n\n", string(d))
}

```

--------------------------------

### Ignore resource by Kind

Source: https://github.com/yannh/kubeconform/blob/master/Readme.md

Validate a file while ignoring a specific resource Kind. This example ignores 'ReplicationController' for all apiVersions.

```bash
# This will ignore ReplicationController for all apiVersions
$ kubeconform -summary -skip ReplicationController fixtures/valid.yaml
Summary: 1 resource found in 1 file - Valid: 0, Invalid: 0, Errors: 0, Skipped: 1
```

--------------------------------

### Validate Kubernetes Manifests with Summary

Source: https://github.com/yannh/kubeconform/blob/master/site/public/index.html

Use this command to get a summary of resources found in your Kubernetes manifest files. It reports the total number of resources, and counts for valid, invalid, errors, and skipped resources.

```bash
$ kubeconform -summary myapp/deployment.yaml
Summary: 5 resources found in 1 file - Valid: 5, Invalid: 0, Errors: 0, Skipped: 0
```

--------------------------------

### Ignore resource by GVK

Source: https://github.com/yannh/kubeconform/blob/master/Readme.md

Validate a file while ignoring a specific resource using Group, Version, Kind (GVK) notation. This example ignores 'ReplicationController' only for apiVersion 'v1'.

```bash
# This will ignore ReplicationController only for apiVersion v1
$ kubeconform -summary -skip v1/ReplicationController fixtures/valid.yaml
Summary: 1 resource found in 1 file - Valid: 0, Invalid: 0, Errors: 0, Skipped: 1
```

--------------------------------

### Validate a folder with increased concurrency

Source: https://github.com/yannh/kubeconform/blob/master/Readme.md

Validate all manifests within a folder, increasing the number of parallel workers for faster processing. Shows example output with errors and a summary.

```bash
$ kubeconform -summary -n 16 fixtures
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
[...] 
Summary: 65 resources found in 34 files - Valid: 55, Invalid: 2, Errors: 8 Skipped: 0
```

--------------------------------

### Kubeconform Help Usage

Source: https://github.com/yannh/kubeconform/blob/master/Readme.md

Display the help information for Kubeconform, showing available options and their descriptions.

```bash
$ kubeconform -h
Usage: kubeconform [OPTION]... [FILE OR FOLDER]...
  -cache string
    	cache schemas downloaded via HTTP to this folder
  -debug
    	print debug information
  -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. This will make your HTTPS connections insecure
  -kubernetes-version string
    	version of Kubernetes to validate against, e.g.: 1.18.0 (default "master")
  -n int
    	number of goroutines to run concurrently (default 4)
  -output string
    	output format - json, junit, pretty, tap, text (default "text")
  -reject string
    	comma-separated list of kinds or GVKs to reject
  -schema-location value
    	override schemas location search path (can be specified multiple times)
  -skip string
    	comma-separated list of kinds or GVKs to ignore
  -strict
    	disallow additional properties not in schema or duplicated keys
  -summary
    	print a summary at the end (ignored for junit output)
  -v	show version information
  -verbose
    	print results for all resources (ignored for tap and junit output)

```

--------------------------------

### Display Kubeconform Help Information

Source: https://github.com/yannh/kubeconform/blob/master/site/content/docs/usage.md

Use the -h flag to display all available command-line options and their descriptions. This is useful for understanding the full range of Kubeconform's capabilities.

```bash
./bin/kubeconform -h
```

--------------------------------

### Build and Run openapi2jsonschema-go Tool

Source: https://github.com/yannh/kubeconform/blob/master/Readme.md

These commands demonstrate how to build the openapi2jsonschema-go tool locally and use it to convert an OpenAPI file to a JSON schema.

```bash
$ cd openapi2jsonschema-go && make local-build
$ ./bin/openapi2jsonschema https://raw.githubusercontent.com/aws/amazon-sagemaker-operator-for-k8s/master/config/crd/bases/sagemaker.aws.amazon.com_trainingjobs.yaml
```

--------------------------------

### Pass Manifests via Stdin with Summary

Source: https://github.com/yannh/kubeconform/blob/master/site/public/docs/usage/index.html

Validates Kubernetes manifests piped into Kubeconform via standard input, displaying a summary of the validation results.

```bash
cat fixtures/valid.yaml  | ./bin/kubeconform -summary
```

```text
Summary: 1 resource found parsing stdin - Valid: 1, Invalid: 0, Errors: 0 Skipped: 0
```

--------------------------------

### Default Schema Location vs. Explicit URL

Source: https://github.com/yannh/kubeconform/blob/master/site/content/docs/crd-support.md

Demonstrates equivalent commands for setting the default schema location. The 'default' alias points to a specific GitHub URL pattern.

```bash
./bin/kubeconform fixtures/valid.yaml

```

```bash
./bin/kubeconform -schema-location default fixtures/valid.yaml

```

```bash
./bin/kubeconform -schema-location 'https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/{{ .NormalizedKubernetesVersion }}-standalone{{ .StrictSuffix }}/{{ .ResourceKind }}{{ .KindSuffix }}.json' fixtures/valid.yaml

```

--------------------------------

### Speed Comparison: Kubeconform vs Kubeval

Source: https://github.com/yannh/kubeconform/blob/master/Readme.md

Compares the execution time of Kubeconform and Kubeval on a large Kubernetes configuration. Shows Kubeconform's performance advantage.

```bash
time kubeconform -ignore-missing-schemas -n 8 -summary  preview staging production
Summary: 50714 resources found in 35139 files - Valid: 27334, Invalid: 0, Errors: 0 Skipped: 23380
real	0m6,710s
user	0m38,701s
sys	0m1,161s
```

```bash
time kubeval -d preview,staging,production --ignore-missing-schemas --quiet
[... Skipping output]
real	0m35,336s
user	0m0,717s
sys	0m1,069s
```

--------------------------------

### Marshal and Unmarshal YAML

Source: https://github.com/yannh/kubeconform/blob/master/vendor/sigs.k8s.io/yaml/README.md

Demonstrates how to marshal a Go struct into YAML format and unmarshal YAML back into a Go struct using the yaml.Marshal and yaml.Unmarshal functions.

```APIDOC
## Marshal and Unmarshal YAML

### Description
This example shows how to convert a Go struct into YAML format using `yaml.Marshal` and then parse that YAML back into a Go struct using `yaml.Unmarshal`.

### Usage
```go
package main

import (
	"fmt"

	"sigs.k8s.io/yaml"
)

type Person struct {
	Name string `json:"name"` // Affects YAML field names too.
	Age  int    `json:"age"`
}

func main() {
	// Marshal a Person struct to YAML.
	p := Person{"John", 30}
	y, err := yaml.Marshal(p)
	if err != nil {
		fmt.Printf("err: %v\n", err)
		return
	}
	fmt.Println(string(y))
	/* Output:
	age: 30
	name: John
	*/

	// Unmarshal the YAML back into a Person struct.
	var p2 Person
	err = yaml.Unmarshal(y, &p2)
	if err != nil {
		fmt.Printf("err: %v\n", err)
		return
	}
	fmt.Println(p2)
	/* Output:
	{John 30}
	*/
}
```
```

--------------------------------

### Unmarshal and Marshal YAML Data in Go

Source: https://github.com/yannh/kubeconform/blob/master/vendor/go.yaml.in/yaml/v2/README.md

Demonstrates how to unmarshal YAML data into a Go struct and a map, and then marshal them back into YAML format. Ensure struct fields are public for correct unmarshalling.

```Go
package main

import (
        "fmt"
        "log"

        "go.yaml.in/yaml/v2"
)

var data = `
a: Easy!
b:
  c: 2
  d: [3, 4]
`

// Note: struct fields must be public in order for unmarshal to
// correctly populate the data.
type T struct {
        A string
        B struct {
                RenamedC int   `yaml:"c"`
                D        []int `yaml:",flow"`
        }
}

func main() {
        t := T{}
    
        err := yaml.Unmarshal([]byte(data), &t)
        if err != nil {
                log.Fatalf("error: %v", err)
        }
        fmt.Printf("--- t:\n%v\n\n", t)
    
        d, err := yaml.Marshal(&t)
        if err != nil {
                log.Fatalf("error: %v", err)
        }
        fmt.Printf("--- t dump:\n%s\n\n", string(d))
    
        m := make(map[interface{}]interface{})
    
        err = yaml.Unmarshal([]byte(data), &m)
        if err != nil {
                log.Fatalf("error: %v", err)
        }
        fmt.Printf("--- m:\n%v\n\n", m)
    
        d, err = yaml.Marshal(&m)
        if err != nil {
                log.Fatalf("error: %v", err)
        }
        fmt.Printf("--- m dump:\n%s\n\n", string(d))
}

```

--------------------------------

### GitHub Action Workflow for Kubeconform

Source: https://github.com/yannh/kubeconform/blob/master/site/content/docs/usage-as-github-action.md

This workflow demonstrates how to log into GitHub Packages, check out your code, and run Kubeconform as a Docker action to validate Kubernetes configurations.

```yaml
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/"
```

--------------------------------

### Run Kubeconform in GitHub Actions

Source: https://github.com/yannh/kubeconform/blob/master/site/public/docs/usage-as-github-action/index.html

This workflow demonstrates how to use Kubeconform within a GitHub Actions job. It includes logging into GitHub Packages, checking out code, and running Kubeconform via its Docker image with specified arguments.

```yaml
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/"
    
```

--------------------------------

### Equivalent Kubeconform Commands for Schema Location

Source: https://github.com/yannh/kubeconform/blob/master/Readme.md

These commands demonstrate equivalent ways to specify the schema location for Kubeconform validation.

```bash
$ kubeconform fixtures/valid.yaml
```

```bash
$ kubeconform -schema-location default fixtures/valid.yaml
```

```bash
$ kubeconform -schema-location 'https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/{{.NormalizedKubernetesVersion}}-standalone{{.StrictSuffix}}/{{.ResourceKind}}{{.KindSuffix}}.json' fixtures/valid.yaml
```

--------------------------------

### Custom Schema Location with Go Templating

Source: https://github.com/yannh/kubeconform/blob/master/site/public/docs/crd-support/index.html

This command demonstrates using a Go templated string for the schema location, allowing dynamic lookup based on Kubernetes version and resource kind.

```bash
./bin/kubeconform -schema-location 'https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/{{ .NormalizedKubernetesVersion }}-standalone{{ .StrictSuffix }}/{{ .ResourceKind }}{{ .KindSuffix }}.json' fixtures/valid.yaml
```

--------------------------------

### Convert retryablehttp Client to stdlib http Client

Source: https://github.com/yannh/kubeconform/blob/master/vendor/github.com/hashicorp/go-retryablehttp/README.md

Shows how to convert a configured retryablehttp.Client to a standard Go *http.Client. This allows leveraging retryablehttp's features with existing http.Client usage.

```go
retryClient := retryablehttp.NewClient()
retryClient.RetryMax = 10

standardClient := retryClient.StandardClient() // *http.Client
```

--------------------------------

### Marshal and Unmarshal Structs with YAML

Source: https://github.com/yannh/kubeconform/blob/master/vendor/sigs.k8s.io/yaml/README.md

Demonstrates marshaling a Go struct to YAML and unmarshaling YAML back into a struct. JSON struct tags influence YAML field names.

```go
package main

import (
	"fmt"

	"sigs.k8s.io/yaml"
)

type Person struct {
	Name string `json:"name"` // Affects YAML field names too.
	Age  int    `json:"age"`
}

func main() {
	// Marshal a Person struct to YAML.
	p := Person{"John", 30}
	y, err := yaml.Marshal(p)
	if err != nil {
		fmt.Printf("err: %v\n", err)
		return
	}
	fmt.Println(string(y))
	/* Output:
	age: 30
	name: John
	*/

	// Unmarshal the YAML back into a Person struct.
	var p2 Person
	err = yaml.Unmarshal(y, &p2)
	if err != nil {
		fmt.Printf("err: %v\n", err)
		return
	}
	fmt.Println(p2)
	/* Output:
	{John 30}
	*/
}
```

--------------------------------

### Validating OpenShift Manifests

Source: https://github.com/yannh/kubeconform/blob/master/site/public/docs/crd-support/index.html

This command demonstrates validating OpenShift manifests by specifying a custom schema location for OpenShift schemas and setting the Kubernetes version.

```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
```

--------------------------------

### GitHub Actions Workflow for Kubeconform

Source: https://github.com/yannh/kubeconform/blob/master/Readme.md

Integrate Kubeconform into a GitHub Actions workflow using its Docker image. Ensure to log in to GitHub Container Registry.

```yaml
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:latest
        with:
          entrypoint: '/kubeconform'
          args: "-summary -output json kubeconfigs/"
```

--------------------------------

### Convert JSON to YAML and Vice Versa

Source: https://github.com/yannh/kubeconform/blob/master/vendor/sigs.k8s.io/yaml/README.md

Utilizes yaml.JSONToYAML for converting JSON byte slices to YAML and yaml.YAMLToJSON for the reverse conversion.

```go
package main

import (
	"fmt"

	"sigs.k8s.io/yaml"
)

func main() {
	j := []byte(`{"name": "John", "age": 30}`)
	y, err := yaml.JSONToYAML(j)
	if err != nil {
		fmt.Printf("err: %v\n", err)
		return
	}
	fmt.Println(string(y))
	/* Output:
	age: 30
	name: John
	*/
	j2, err := yaml.YAMLToJSON(y)
	if err != nil {
		fmt.Printf("err: %v\n", err)
		return
	}
	fmt.Println(string(j2))
	/* Output:
	{"age":30,"name":"John"}
	*/
}
```

--------------------------------

### Convert Between JSON and YAML

Source: https://github.com/yannh/kubeconform/blob/master/vendor/sigs.k8s.io/yaml/README.md

Illustrates the usage of yaml.YAMLToJSON and yaml.JSONToYAML for converting data between JSON and YAML formats.

```APIDOC
## Convert Between JSON and YAML

### Description
This example demonstrates how to convert JSON data to YAML using `yaml.JSONToYAML` and YAML data to JSON using `yaml.YAMLToJSON`.

### Usage
```go
package main

import (
	"fmt"

	"sigs.k8s.io/yaml"
)

func main() {
	j := []byte(`{"name": "John", "age": 30}`)
	y, err := yaml.JSONToYAML(j)
	if err != nil {
		fmt.Printf("err: %v\n", err)
		return
	}
	fmt.Println(string(y))
	/* Output:
	age: 30
	name: John
	*/
	j2, err := yaml.YAMLToJSON(y)
	if err != nil {
		fmt.Printf("err: %v\n", err)
		return
	}
	fmt.Println(string(j2))
	/* Output:
	{"age":30,"name":"John"}
	*/
}
```
```

--------------------------------

### Download schemas using HTTPS_PROXY

Source: https://github.com/yannh/kubeconform/blob/master/Readme.md

Configure Kubeconform to use an HTTPS proxy for downloading schema files by setting the HTTPS_PROXY environment variable.

```bash
$ HTTPS_PROXY=proxy.local bin/kubeconform fixtures/valid.yaml
```

--------------------------------

### Default Schema Location

Source: https://github.com/yannh/kubeconform/blob/master/site/public/docs/crd-support/index.html

This command uses the default schema location, which is equivalent to specifying the default alias.

```bash
./bin/kubeconform fixtures/valid.yaml
```

```bash
./bin/kubeconform -schema-location default fixtures/valid.yaml
```

--------------------------------

### Validate a Single Valid Kubernetes File

Source: https://github.com/yannh/kubeconform/blob/master/site/public/docs/usage/index.html

Executes Kubeconform on a single YAML file expected to be valid. The exit code 0 indicates successful validation.

```bash
./bin/kubeconform fixtures/valid.yaml

```

```bash
echo $?
```

--------------------------------

### Validating CRDs with Local Schemas

Source: https://github.com/yannh/kubeconform/blob/master/site/public/docs/crd-support/index.html

This command shows how to validate custom resources by providing a local directory for schema lookups, in addition to the default location.

```bash
./bin/kubeconform -schema-location default -schema-location 'schemas/{{ .ResourceKind }}{{ .KindSuffix }}.json' fixtures/custom-resource.yaml
```

--------------------------------

### Customize JSON Schema Output Filename

Source: https://github.com/yannh/kubeconform/blob/master/site/content/docs/json-schema-conversion.md

Set the `FILENAME_FORMAT` environment variable to customize the output filename. Available variables include `kind`, `group`, and `version`. The default format is `{kind}_{version}`.

```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
JSON schema written to trainingjob-sagemaker-v1.json
```

--------------------------------

### Kubeconform Command with Custom Schema Location for CRDs

Source: https://github.com/yannh/kubeconform/blob/master/Readme.md

This command shows how to use Kubeconform with both the default schema location and a custom local path for CRD schemas.

```bash
# If the resource Kind is not found in default, also lookup in the schemas/ folder for a matching file
$ kubeconform -schema-location default -schema-location 'schemas/{{ .ResourceKind }}{{ .KindSuffix }}.json' fixtures/custom-resource.yaml
```

--------------------------------

### Validate a Single Valid YAML File

Source: https://github.com/yannh/kubeconform/blob/master/site/content/docs/usage.md

Validate a single YAML file to ensure it conforms to Kubernetes schema. The exit code 0 indicates successful validation.

```bash
./bin/kubeconform fixtures/valid.yaml
$ echo $?
```

--------------------------------

### Customize Output Filename for JSON Schema Conversion

Source: https://github.com/yannh/kubeconform/blob/master/site/public/docs/json-schema-conversion/index.html

Set the `FILENAME_FORMAT` environment variable to customize the output JSON schema filename using available variables like `kind`, `group`, and `version`. The default format is `{kind}_{version}`.

```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
JSON schema written to trainingjob-sagemaker-v1.json

```

--------------------------------

### Set FILENAME_FORMAT Environment Variable for openapi2jsonschema-go

Source: https://github.com/yannh/kubeconform/blob/master/Readme.md

Demonstrates how to use the FILENAME_FORMAT environment variable to customize the output file name when converting OpenAPI to JSON schema.

```bash
export FILENAME_FORMAT='{kind}-{group}-{version}'
./bin/openapi2jsonschema https://raw.githubusercontent.com/aws/amazon-sagemaker-operator-for-k8s/master/config/crd/bases/sagemaker.aws.amazon.com_trainingjobs.yaml
```

```bash
export FILENAME_FORMAT='{kind}-{fullgroup}-{version}'
./bin/openapi2jsonschema https://raw.githubusercontent.com/aws/amazon-sagemaker-operator-for-k8s/master/config/crd/bases/sagemaker.aws.amazon.com_trainingjobs.yaml
```

--------------------------------

### Pass Manifests via Stdin

Source: https://github.com/yannh/kubeconform/blob/master/site/content/docs/usage.md

Pipe the content of a YAML file to Kubeconform via stdin for validation. This is useful for integrating Kubeconform into CI/CD pipelines or scripting workflows.

```bash
cat fixtures/valid.yaml  | ./bin/kubeconform -summary
```

--------------------------------

### Convert OpenAPI to JSON Schema

Source: https://github.com/yannh/kubeconform/blob/master/site/content/docs/json-schema-conversion.md

Use the `openapi2jsonschema.py` script to convert an OpenAPI specification URL to a JSON schema file. The output is saved to a file named after the resource's kind and version by default.

```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
JSON schema written to trainingjob_v1.json
```

--------------------------------

### Kubeconform Command with CRDs Catalog Schema Location

Source: https://github.com/yannh/kubeconform/blob/master/Readme.md

This command shows how to configure Kubeconform to look for schemas in the default location and also in Datree's CRDs-catalog.

```bash
$ kubeconform -schema-location default -schema-location 'https://raw.githubusercontent.com/datreeio/CRDs-catalog/main/{{.Group}}/{{.ResourceKind}}_{{.ResourceAPIVersion}}.json' [MANIFEST]
```

--------------------------------

### GitLab CI Job for Kubeconform

Source: https://github.com/yannh/kubeconform/blob/master/Readme.md

Use the Kubeconform Docker image within a GitLab CI job for manifest validation. The image is configured to use the alpine variant.

```yaml
lint-kubeconform:
  stage: validate
  image:
    name: ghcr.io/yannh/kubeconform:latest-alpine
    entrypoint: [""]
  script:
  - /kubeconform -summary -output json kubeconfigs/
```

--------------------------------

### Validating CRDs with Local Schema Folder

Source: https://github.com/yannh/kubeconform/blob/master/site/content/docs/crd-support.md

Use this command to validate Custom Resources by providing a local folder containing OpenAPI-converted JSON schemas. Kubeconform will look for matching files in this folder if not found in the default location.

```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

```

--------------------------------

### Validating OpenShift Manifests with Custom Schema

Source: https://github.com/yannh/kubeconform/blob/master/site/content/docs/crd-support.md

Validate OpenShift manifests by specifying a custom schema location pointing to the OpenShift JSON schema repository. Use the -kubernetes-version flag to set the OpenShift version for validation.

```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

```

--------------------------------

### Convert OpenAPI CRD to JSON Schema

Source: https://github.com/yannh/kubeconform/blob/master/site/public/docs/json-schema-conversion/index.html

Use the `openapi2jsonschema.py` script to convert a remote OpenAPI CRD definition to a JSON schema file. The output filename defaults to `{kind}_{version}`.

```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
JSON schema written to trainingjob_v1.json

```

--------------------------------

### Validate a Folder with Increased Parallel Workers

Source: https://github.com/yannh/kubeconform/blob/master/site/content/docs/usage.md

Validate all Kubernetes manifests within a specified folder. The -n flag increases the number of concurrent goroutines for faster processing of multiple files.

```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/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
```

--------------------------------

### Validate an Invalid YAML File with JSON Output and Summary

Source: https://github.com/yannh/kubeconform/blob/master/site/content/docs/usage.md

Validate an invalid YAML file, outputting results in JSON format and including a summary of validation status. The exit code 1 indicates validation failure.

```bash
./bin/kubeconform -summary -output json fixtures/invalid.yaml
{
  "resources": [
    {
      "filename": "fixtures/invalid.yaml",
      "kind": "ReplicationController",
      "version": "v1",
      "status": "INVALID",
      "msg": "Additional property templates is not allowed - Invalid type. Expected: [integer,null], given: string"
    }
  ],
  "summary": {
    "valid": 0,
    "invalid": 1,
    "errors": 0,
    "skipped": 0
  }
}
$ echo $? = 1
```

--------------------------------

### Validate an Invalid File with JSON Output and Summary

Source: https://github.com/yannh/kubeconform/blob/master/site/public/docs/usage/index.html

Validates an invalid YAML file, outputs the results in JSON format, and includes a summary of validation outcomes. The exit code 1 indicates validation errors.

```bash
./bin/kubeconform -summary -output json fixtures/invalid.yaml
```

```json
{
  "resources": [
    {
      "filename": "fixtures/invalid.yaml",
      "kind": "ReplicationController",
      "version": "v1",
      "status": "INVALID",
      "msg": "Additional property templates is not allowed - Invalid type. Expected: [integer,null], given: string"
    }
  ],
  "summary": {
    "valid": 0,
    "invalid": 1,
    "errors": 0,
    "skipped": 0
  }
}
```

```bash
echo $?
```
Tokens:
Raw