Documentation ¶
Overview ¶
Package v3 contains API Schema definitions for the management v3 API group +kubebuilder:object:generate=true +groupName=management.cattle.io
Index ¶
- Variables
- type GitOrgScan
- type GitOrgScanList
- type GitOrgScanSpec
- type GitOrgScanStatus
- type GitRepoScan
- type GitRepoScanList
- type GitRepoScanSpec
- type GitRepoScanStatus
- type GithubOrgScanConfig
- type OrgScanConfig
- type RepoScanConfig
- type RepoScanError
- type ScanException
- type ScanExceptionList
- type ScanExceptionSpec
Constants ¶
This section is empty.
Variables ¶
var ( // GroupVersion is group version used to register these objects GroupVersion = schema.GroupVersion{Group: "management.cattle.io", Version: "v3"} // SchemeBuilder is used to add go types to the GroupVersionKind scheme SchemeBuilder = &scheme.Builder{GroupVersion: GroupVersion} // AddToScheme adds the types in this group-version to the given scheme. AddToScheme = SchemeBuilder.AddToScheme )
Functions ¶
This section is empty.
Types ¶
type GitOrgScan ¶
type GitOrgScan struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` Spec GitOrgScanSpec `json:"spec,omitempty"` Status GitOrgScanStatus `json:"status,omitempty"` }
GitOrgScan is the Schema for the gitorgscans API
func (*GitOrgScan) DeepCopy ¶
func (in *GitOrgScan) DeepCopy() *GitOrgScan
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new GitOrgScan.
func (*GitOrgScan) DeepCopyInto ¶
func (in *GitOrgScan) DeepCopyInto(out *GitOrgScan)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*GitOrgScan) DeepCopyObject ¶
func (in *GitOrgScan) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type GitOrgScanList ¶
type GitOrgScanList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata,omitempty"` Items []GitOrgScan `json:"items"` }
GitOrgScanList contains a list of GitOrgScan
func (*GitOrgScanList) DeepCopy ¶
func (in *GitOrgScanList) DeepCopy() *GitOrgScanList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new GitOrgScanList.
func (*GitOrgScanList) DeepCopyInto ¶
func (in *GitOrgScanList) DeepCopyInto(out *GitOrgScanList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*GitOrgScanList) DeepCopyObject ¶
func (in *GitOrgScanList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type GitOrgScanSpec ¶
type GitOrgScanSpec struct { // FullOrgName is the name of the org, in the full path, as known by the git provider FullOrgName string `json:"fullOrgName"` // OrgScanConfig contains options to determine when/how to refresh org information OrgScanConfig OrgScanConfig `json:"orgScanConfig"` // RepoScanConfig is the ScanConfig to be used for every repo in this org RepoScanConfig RepoScanConfig `json:"repoScanConfig"` }
GitOrgScanSpec defines the desired state of GitOrgScan
func (*GitOrgScanSpec) DeepCopy ¶
func (in *GitOrgScanSpec) DeepCopy() *GitOrgScanSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new GitOrgScanSpec.
func (*GitOrgScanSpec) DeepCopyInto ¶
func (in *GitOrgScanSpec) DeepCopyInto(out *GitOrgScanSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type GitOrgScanStatus ¶
type GitOrgScanStatus struct { // Deployed indicates if the scans for the sub-resources of this org have been successfully rolled out Deployed bool `json:"deployed"` }
GitOrgScanStatus defines the observed state of GitOrgScan
func (*GitOrgScanStatus) DeepCopy ¶
func (in *GitOrgScanStatus) DeepCopy() *GitOrgScanStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new GitOrgScanStatus.
func (*GitOrgScanStatus) DeepCopyInto ¶
func (in *GitOrgScanStatus) DeepCopyInto(out *GitOrgScanStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type GitRepoScan ¶
type GitRepoScan struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` Spec GitRepoScanSpec `json:"spec,omitempty"` Status GitRepoScanStatus `json:"status,omitempty"` }
GitRepoScan is the Schema for the gitreposcans API
func (*GitRepoScan) DeepCopy ¶
func (in *GitRepoScan) DeepCopy() *GitRepoScan
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new GitRepoScan.
func (*GitRepoScan) DeepCopyInto ¶
func (in *GitRepoScan) DeepCopyInto(out *GitRepoScan)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*GitRepoScan) DeepCopyObject ¶
func (in *GitRepoScan) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type GitRepoScanList ¶
type GitRepoScanList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata,omitempty"` Items []GitRepoScan `json:"items"` }
GitRepoScanList contains a list of GitRepoScan
func (*GitRepoScanList) DeepCopy ¶
func (in *GitRepoScanList) DeepCopy() *GitRepoScanList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new GitRepoScanList.
func (*GitRepoScanList) DeepCopyInto ¶
func (in *GitRepoScanList) DeepCopyInto(out *GitRepoScanList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*GitRepoScanList) DeepCopyObject ¶
func (in *GitRepoScanList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type GitRepoScanSpec ¶
type GitRepoScanSpec struct { // RepoUrl defines the target git repo to scan. Can be in https format (https://github.com/MbolotSuse/rancher-token-revoker.git) // or in ssh format (git@github.com:MbolotSuse/rancher-token-revoker.git) RepoUrl string `json:"repoUrl"` // Config options for this scan Config RepoScanConfig `json:"scanConfig"` }
GitRepoScanSpec defines the desired state of GitRepoScan
func (*GitRepoScanSpec) DeepCopy ¶
func (in *GitRepoScanSpec) DeepCopy() *GitRepoScanSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new GitRepoScanSpec.
func (*GitRepoScanSpec) DeepCopyInto ¶
func (in *GitRepoScanSpec) DeepCopyInto(out *GitRepoScanSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type GitRepoScanStatus ¶
type GitRepoScanStatus struct { // LastScanTime records the last time a scan was completed in RFC3339 format. If "", no scans have been attempted LastScanTime string `json:"lastScanTime,omitempty"` // ScanError records the error from the last scan. If nil, the last scan succeeded ScanError *RepoScanError `json:"scanError,omitempty"` }
GitRepoScanStatus defines the observed state of GitRepoScan
func (*GitRepoScanStatus) DeepCopy ¶
func (in *GitRepoScanStatus) DeepCopy() *GitRepoScanStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new GitRepoScanStatus.
func (*GitRepoScanStatus) DeepCopyInto ¶
func (in *GitRepoScanStatus) DeepCopyInto(out *GitRepoScanStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type GithubOrgScanConfig ¶
type GithubOrgScanConfig struct { // BaseUrl is the baseURl used for api calls to github. If empty, uses the default url for the public github instance BaseUrl string `json:"baseUrl,omitempty"` // UploadUrl is the uploadURl used for api calls to github. If empty, uses the default url for the public github instance UploadUrl string `json:"uploadUrl,omitempty"` // SecretName is the name of the secret that will be used to query the API for org information. Required value. // Secret.Type must be management.cattle.io/github-token, which has one key "accessToken" and one value (the access token) SecretName string `json:"secretName"` }
GithubOrgScanConfig holds scan options specific to a github org
func (*GithubOrgScanConfig) DeepCopy ¶
func (in *GithubOrgScanConfig) DeepCopy() *GithubOrgScanConfig
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new GithubOrgScanConfig.
func (*GithubOrgScanConfig) DeepCopyInto ¶
func (in *GithubOrgScanConfig) DeepCopyInto(out *GithubOrgScanConfig)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type OrgScanConfig ¶
type OrgScanConfig struct { // OrgScanInterval is the time between the last scan's start time and the next time a scan will be run. OrgScanInterval int `json:"orgScanInterval,omitempty"` // RepoUrlType is the type of url which should be used for each url in the repo. Valid values are https, ssh RepoUrlType string `json:"repoUrlType,omitempty"` // GithubOrgScanConfig is the config containing github-specific options. GithubOrgScanConfig *GithubOrgScanConfig `json:"githubOrgScanConfig"` }
OrgScanConfig holds options related to how the org's information (such as list of repos) is refreshed, and how often
func (*OrgScanConfig) DeepCopy ¶
func (in *OrgScanConfig) DeepCopy() *OrgScanConfig
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new OrgScanConfig.
func (*OrgScanConfig) DeepCopyInto ¶
func (in *OrgScanConfig) DeepCopyInto(out *OrgScanConfig)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type RepoScanConfig ¶
type RepoScanConfig struct { // RepoSecretName is the name of the secret (in the same namespace as the chart is installed in) containing the secret // to access the repo at RepoUrl. If empty, uses the secret configured when installing the controller (revokerOptions.defaultSecretName) RepoSecretName string `json:"repoSecretName,omitempty"` // ScanIntervalSeconds is time between the last scan's start time and the next time a scan will be run. If empty/0, // uses the default configured when installing the controller (revokerOptions.defaultScanInterval) ScanIntervalSeconds int `json:"scanIntervalSeconds,omitempty"` // ForceNoAuth, if true, forces scans for this repo to ignore other settings to use a secret to clone/pull from the repo // Useful for forcing a scan to ignore auth settings setup at the controller level ForceNoAuth bool `json:"forceNoAuth,omitempty"` }
RepoScanConfig represents options for scanning a repo
func (*RepoScanConfig) DeepCopy ¶
func (in *RepoScanConfig) DeepCopy() *RepoScanConfig
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new RepoScanConfig.
func (*RepoScanConfig) DeepCopyInto ¶
func (in *RepoScanConfig) DeepCopyInto(out *RepoScanConfig)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type RepoScanError ¶
type RepoScanError struct { ErrorType string `json:"errorCode,omitempty"` ErrorMessage string `json:"errorMessage,omitempty"` }
RepoScanError defines an error which occurred when scanning a git repo
func (*RepoScanError) DeepCopy ¶
func (in *RepoScanError) DeepCopy() *RepoScanError
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new RepoScanError.
func (*RepoScanError) DeepCopyInto ¶
func (in *RepoScanError) DeepCopyInto(out *RepoScanError)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type ScanException ¶
type ScanException struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` Spec ScanExceptionSpec `json:"spec,omitempty"` }
ScanException is the Schema for the scanexceptions API
func (*ScanException) DeepCopy ¶
func (in *ScanException) DeepCopy() *ScanException
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ScanException.
func (*ScanException) DeepCopyInto ¶
func (in *ScanException) DeepCopyInto(out *ScanException)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*ScanException) DeepCopyObject ¶
func (in *ScanException) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type ScanExceptionList ¶
type ScanExceptionList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata,omitempty"` Items []ScanException `json:"items"` }
ScanExceptionList contains a list of ScanException
func (*ScanExceptionList) DeepCopy ¶
func (in *ScanExceptionList) DeepCopy() *ScanExceptionList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ScanExceptionList.
func (*ScanExceptionList) DeepCopyInto ¶
func (in *ScanExceptionList) DeepCopyInto(out *ScanExceptionList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*ScanExceptionList) DeepCopyObject ¶
func (in *ScanExceptionList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type ScanExceptionSpec ¶
type ScanExceptionSpec struct { // TokenName is the name of the token being excepted from the scan/revoke process. It's recommended that you use TokenValue // for performance reasons. If both values are set, TokenValue will be used TokenName string `json:"tokenName,omitempty"` // TokenValue is the value (token.Token) of the token being excepted from the scan/revoke process. TokenValue string `json:"tokenValue,omitempty"` }
ScanExceptionSpec defines the desired state of ScanException
func (*ScanExceptionSpec) DeepCopy ¶
func (in *ScanExceptionSpec) DeepCopy() *ScanExceptionSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ScanExceptionSpec.
func (*ScanExceptionSpec) DeepCopyInto ¶
func (in *ScanExceptionSpec) DeepCopyInto(out *ScanExceptionSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.