repository.md

API Reference

Packages:

• security.brcmlabs.com/v1

security.brcmlabs.com/v1

Resource Types:

• Repository

Repository

^{↩ Parent}

Repository is the Schema for the repositories API

Name	Type	Description	Required
apiVersion	string	security.brcmlabs.com/v1	true
kind	string	Repository	true
metadata	object	Refer to the Kubernetes API documentation for the fields of the `metadata` field.	true
spec	object	Spec - Repository Spec	false
status	object	Status - Repository Status	false

Repository.spec

^{↩ Parent}

Spec - Repository Spec

Name	Type	Description	Required
endpoint	string	Endoint - Git repository endpoint	true
annotations	map[string]string	Annotations - Custom Annotations	false
auth	object	Auth contains a reference to the credentials required to connect to your Git repository	false
branch	string	Branch - specify which branch to clone if branch and tag are both specified branch will take precedence and tag will be ignored if branch and tag are both missing the entire repository will be cloned	false
enabled	boolean	Enabled - if enabled this repository will be synced	false
labels	map[string]string	Labels - Custom Labels	false
localReference	object	LocalReference lets the Repository controller use a local Kubernetes Configmap/Secret as a repository source This is not currently implemented	false
remoteName	string	Remote Name - defaults to "origin"	false
sync	object	RepositorySyncConfig defines how often this repository is synced	false
tag	string	Tag - clone a specific tag. tags do not change, once cloned this will not be checked for updates	false
type	string	Type of Repository - Git or HTTP	false

Repository.spec.auth

^{↩ Parent}

Auth contains a reference to the credentials required to connect to your Git repository

Name	Type	Description	Required
existingSecretName	string	ExistingSecretName reference an existing secret	false
knownHosts	string	KnownHosts is required for SSH Auth	false
password	string	Password repository Password password or token are acceptable	false
sshKey	string	SSHKey for Git SSH Authentication	false
sshKeyPass	string	SSHKeyPass	false
token	string	Token repository Access Token	false
type	string	Auth Type defaults to basic, possible options are none, basic or ssh	false
username	string	Username repository username	false
vendor	string	Vendor i.e. Github, Gitlab, BitBucket	false

Repository.spec.localReference

^{↩ Parent}

LocalReference lets the Repository controller use a local Kubernetes Configmap/Secret as a repository source This is not currently implemented

Name	Type	Description	Required
configMapName	string		false
secretName	string		false

Repository.spec.sync

^{↩ Parent}

RepositorySyncConfig defines how often this repository is synced

Name	Type	Description	Required
interval	integer	Configure how frequently the remote is checked for new commits	false

Repository.status

^{↩ Parent}

Status - Repository Status

Name	Type	Description	Required
commit	string	Commit is either current git commit that has been synced or a sha1sum of the http repository contents	false
lastAppliedSummary	string		false
name	string	Name of the Repository	false
ready	boolean	Ready to apply to Gateway Deployments	false
storageSecretName	string	StorageSecretName is the Kubernetes Secret that this repository is stored in	false
summary	string		false
updated	string	Updated the last time this repository was successfully updated	false
vendor	string		false