Github Resource Repository

Mon, 01 Jan 0001 00:00:00 +0000

Overview

The GithubResourceRepository can be used to load resources from a public or private GitHub repository.

Configuration

jikkou {
 repositories = [
 {
 # Name of your local repositories 
 name = "<string>"
 # The fully qualified class name (FQCN) of the repository
 type = io.jikkou.core.repository.GithubResourceRepository
 config {
 # Specify the GitHub repository in the format 'owner/repo'
 repository = "<string>"
 
 # Specify the branch or ref to load resources from
 branch = main
 
 # Specify the paths/directories in the repository containing the resource definitions
 paths = [] # Default: **/*.{yaml,yml}
 
 # Specify the pattern used to match YAML file paths.
 # Pattern should be passed in the form of 'syntax:pattern'. The "glob" and "regex" syntaxes are supported (e.g.: **/*.{yaml,yml}).
 # If no syntax is specified the 'glob' syntax is used.
 file-pattern = "**/*.{yaml,yml}"
 
 # Specify the locations of the values-files containing the variables to pass into the template engine built-in object 'Values'.
 values-files = []
 
 # Specify the pattern used to match YAML file paths when one or multiple directories are given through the `values-files` property.
 # Pattern should be passed in the form of 'syntax:pattern'. The "glob" and "regex" syntaxes are supported (e.g.: **/*.{yaml,yml}).
 # If no syntax is specified the 'glob' syntax is used.
 values-file-name = "<string>" # Default: **/*.{yaml,yml}
 
 # The labels to be added to all resources loaded from the repository
 labels {
 <label_key> = <label_value>
 }
 }
 }
 ]
}

Local Resource Repository

Mon, 01 Jan 0001 00:00:00 +0000

Overview

The LocalResourceRepository can be used to load resources from local files or directories.

Configuration

jikkou {
 repositories = [
 {
 # Name of your local repositories 
 name = "<string>"
 # The fully qualified class name (FQCN) of the repository
 type = io.jikkou.core.repository.LocalResourceRepository
 config {
 # Specify the locations containing the definitions for resources in a YAML file, a directory.
 files = []
 
 # Specify the pattern used to match YAML file paths when one or multiple directories are given through the `files` property.
 # Pattern should be passed in the form of 'syntax:pattern'. The "glob" and "regex" syntaxes are supported (e.g.: **/*.{yaml,yml}).
 # If no syntax is specified the 'glob' syntax is used.
 file-name = "<string>"  # Default: **/*.{yaml,yml}
 
 # Specify the locations of the values-files containing the variables to pass into the template engine built-in object 'Values'.
 values-files = []
 
 # Specify the pattern used to match YAML file paths when one or multiple directories are given through the `values-files` property.
 # Pattern should be passed in the form of 'syntax:pattern'. The "glob" and "regex" syntaxes are supported (e.g.: **/*.{yaml,yml}).
 # If no syntax is specified the 'glob' syntax is used.
 values-file-name = "<string>" # Default: **/*.{yaml,yml}
 
 # The labels to add to all resources loaded from the repository
 labels {
 <label_key> = <label_value>
 }
 }
 }
 ]
}

Resource Repositories on Jikkou

Github Resource Repository

Overview

Configuration

Local Resource Repository

Overview

Configuration