package
0.0.0-20240919015114-36df0cc821fa
Repository: https://github.com/opswave/go-jenkins.git
Documentation: pkg.go.dev

# Functions

BuildPipelineRunIdentifier builds PipelineRun identifier with Pipeline name, SCM reference name and run ID.
GetLastChanges returns the last changes.
GetSupportedCredentialTypes gets all supported credential types.
Resource is required by pkg/client/listers/...

# Constants

AddonFinalizerName is the name of Addone finalizer.
AddonInstallStrategyHelm represents to install via helm.
AddonInstallStrategyOperator represents the full operator feature.
AddonInstallStrategySimple represents a single YAML file to install addon.
AddonInstallStrategySimpleOperator represents a single Operator image to install addon.
AnnotationKeyGitRepos are the references of target git repositories.
AnnotationKeyWebhookUpdates is a signal that should update the webhooks.
BasicAuthPasswordKey is the key of the password or token for SecretTypeBasicAuth secrets.
BasicAuthUsernameKey is the key of the username for SecretTypeBasicAuth secrets.
Branch represents an independent line of development.
Cancelled indicates that the PipelineRun has been cancelled.
ConditionFalse means a resource is not in the condition.
ConditionReady indicates that the pipeline is ready.
ConditionSucceeded indicates that the pipeline has finished.
ConditionTrue means a resource is in the condition.
ConditionUnknown mean kubernetes can't decide if a resource is in the condition or not.
CredentialAutoSyncAnnoKey is used to indicate whether the secret is automatically synchronized to devops.
* We use a special type of secret as a credential for DevOps.
* We use a special type of secret as a credential for DevOps.
* We use a special type of secret as a credential for DevOps.
* We use a special type of secret as a credential for DevOps.
No description provided by the author
No description provided by the author
* We use a special type of secret as a credential for DevOps.
* We use a special type of secret as a credential for DevOps.
No description provided by the author
No description provided by the author
Failed indicates that the PipelineRun has failed.
GitRepoFinalizerName is the finalizer name of the git repository.
GroupName is the Kubernetes resource group name for Devops types.
JenkinsPipelineRunIDAnnoKey is annotation key of Jenkins PipelineRun ID.
JenkinsPipelineRunStagesStatusAnnoKey is annotation key of Jenkins stages' status of Jenkins PipelineRun.
JenkinsPipelineRunStatusAnnoKey is annotation key of status of Jenkins PipelineRun.
KubeConfigSecretKey is the key of the secret for SecretTypeKubeConfig secrets.
MergeRequest is a request from someone to merge in code from one branch to another.
No description provided by the author
No description provided by the author
ParameterTypeBool represents a parameter in boolean format.
ParameterTypeCode represents a parameter in string format that contains some code lines.
ParameterTypeEnum represents a parameter in enum format.
ParameterTypeHidden represents a parameter that is hidden.
ParameterTypeImportCodeRepo represents a parameter that is import values to other parameters from code repositories.
ParameterTypeNumber represents a parameter in number format.
ParameterTypeSecret represents a parameter in secret format.
ParameterTypeString represents a parameter in string format, expect this is a single line.
ParameterTypeText represents a parameter in string format, expect this is multi-line.
Pause indicates we need to pause the current PipelineRun.
Pending indicates that the PipelineRun is pending.
No description provided by the author
PipelineJenkinsBranchesAnnoKey is the annotation key of Jenkins Pipeline branches.
PipelineJenkinsfileEditModeAnnoKey is the annotation key of the Jenkinsfile edit mode.
PipelineJenkinsfileEditModeJSON indicates the Jenkinsfile editing mode is JSON.
PipelineJenkinsfileEditModeRaw indicates the Jenkinsfile editing mode is groovy.
PipelineJenkinsfileValidateAnnoKey is the annotation key of the Jenkinsfile validate, success or failure.
PipelineJenkinsfileValidateFailure indicates the Jenkinsfile validate is failure.
PipelineJenkinsfileValidateSuccess indicates the Jenkinsfile validate is success.
PipelineJenkinsfileValueAnnoKey is the annotation key of the Jenkinsfile content.
PipelineJenkinsMetadataAnnoKey is the annotation key of Jenkins Pipeline data.
No description provided by the author
PipelineNameLabelKey is label key of Pipeline name.
No description provided by the author
PipelineRequestToSyncRunsAnnoKey is the annotation key of requesting to synchronize PipelineRun after a dedicated time.
PipelineRunCreatorAnnoKey is annotation key of PipelineRun's creator.
PipelineRunFinalizerName is the name of PipelineRun finalizer.
PipelineRunIdentifierIndexerName is an indexer name of PipelineRun identifier.
PipelineRunOrphanLabelKey is label key of orphan Jenkins PipelineRun which type of value is bool.
PipelineRunSCMRefNameField is the field name of SCM reference name in PipelineRun spec.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
PullRequest is a feature that makes it easier for developers to collaborate using GitHub, BitBucket or others.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Resume indicates we need to resume the current PipelineRun.
RetrieveFailed indicates that it failed to retrieve the latest running data.
Running indicates that the PipelineRun is running.
SecretTextSecretKey is the key of the secret for SecretTypeSecretText secrets.
SecretTypeBasicAuth contains data needed for basic authentication.
SecretTypeKubeConfig contains data.
SecretTypeSecretText contains data.
SecretTypeSSHAuth contains data needed for ssh authentication.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
SSHAuthPrivateKey is the key of the passphrase for SecretTypeSSHAuth secrets.
SSHAuthPrivateKey is the key of the privatekey for SecretTypeSSHAuth secrets.
SSHAuthUsernameKey is the key of the username for SecretTypeSSHAuth secrets.
Started indicates PipelineRun has been triggered.
Stop indicates we need to stop the current PipelineRun.
Succeeded indicates that the PipelineRun has succeeded.
Tag points to specific points in SCM history.
TriggerFailed indicates that it failed to trigger build API.
Unknown indicates that the PipelineRun has an unknown status.
Updated indicates PipelineRun's running data has been updated.

# Variables

AddToScheme adds the types in this group-version to the given scheme.
DefaultSecretKeyMapping mainly used as the Jenkinsfile environment variables.
GroupVersion is group version used to register these objects.
SchemeBuilder is used to add go types to the GroupVersionKind scheme.
StepTemplatePhaseInit indicates the step template is not ready to use.
StepTemplatePhaseReady indicates the step template is ready to use.

# Structs

Addon represents a plugin (addon) of ks-devops.
AddonList contains a list of AddonStrategy.
AddonSpec is the specification of an Addon.
AddonStatus represents the status of an addon.
AddonStrategy represents an addonStrategy.
AddonStrategyList contains a list of AddonStrategy.
AddStrategySpec is the specification of an AddonStrategy.
ApplicationDestination holds information about the application's destination.
Argo represents the Argo CD specification.
No description provided by the author
ClusterStepTemplate is the Schema for the steptemplates API.
ClusterStepTemplateList contains a list of ClusterStepTemplate.
ClusterTemplate is the Schema for the clustertemplates API.
ClusterTemplateList contains a list of ClusterTemplate.
Condition contains details for the current condition of this PipelineRun.
DevOpsProject is the Schema for the devopsprojects API +kubebuilder:resource:categories="devops",scope="Cluster" +k8s:openapi-gen=true.
DevOpsProjectList contains a list of DevOpsProject.
DevOpsProjectSpec defines the desired state of DevOpsProject.
DevOpsProjectStatus defines the observed state of DevOpsProject.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
GithubSource and BitbucketServerSource have the same structure, but we don't use one due to crd errors.
No description provided by the author
GitRepository is the Schema for the webhook API +k8s:openapi-gen=true +kubebuilder:printcolumn:name="Provider",type="string",JSONPath=".spec.provider" +kubebuilder:printcolumn:name="Server",type="string",JSONPath=".spec.server" +kubebuilder:printcolumn:name="URL",type="string",JSONPath=".spec.url".
GitRepositoryList contains a list of GitRepository.
GitRepositorySpec represents the desired state of a GitRepository.
GitRepositoryStatus represents the status of a git repository.
No description provided by the author
JWTToken holds the issuedAt and expiresAt values of a token.
No description provided by the author
No description provided by the author
No description provided by the author
OrphanedResourceKey is a reference to a resource to be ignored from.
OrphanedResourcesMonitorSettings holds settings of orphaned resources monitoring.
Parameter is an option that can be passed with the endpoint to influence the Pipeline Run.
No description provided by the author
ParameterInStep is the parameter which used in a step.
ParameterValidation is definition of how can we validate our parameter.
Pipeline is the Schema for the pipelines API +k8s:openapi-gen=true +kubebuilder:printcolumn:name="Type",type=string,JSONPath=`.spec.type`,description="The type of a Pipeline" +kubebuilder:printcolumn:name="Age",type=date,JSONPath=`.metadata.creationTimestamp`,description="The age of a Pipeline" +kubebuilder:resource:shortName="pip",categories="devops".
PipelineList contains a list of Pipeline.
PipelineRun is the Schema for the pipelineruns API.
PipelineRunList contains a list of PipelineRun.
PipelineRunSpec defines the desired state of PipelineRun.
PipelineRunStatus defines the observed state of PipelineRun.
PipelineSpec defines the desired state of Pipeline.
PipelineStatus defines the observed state of Pipeline.
ProjectRole represents a role that has access to a project.
No description provided by the author
SCM is a SCM configuration that target PipelineRun requires.
SecretInStep is the secret which used in a step.
SignatureKey is the specification of a key required to verify commit signatures with.
No description provided by the author
StepTemplateSpec defines the desired state of ClusterStepTemplate.
StepTemplateStatus defines the observed state of ClusterStepTemplate.
No description provided by the author
SyncWindow contains the kind, time, duration and attributes that are used to assign the syncWindows to apps.
Template is the Schema for the templates API.
TemplateList contains a list of Template.
TemplateParameter is definition of how can we configure our parameter.
TemplateSpec defines the desired state of Template.
TemplateStatus defines the observed state of Template.
No description provided by the author
Webhook is the Schema for the webhook API +k8s:openapi-gen=true +kubebuilder:printcolumn:name="Server",type="string",JSONPath=".spec.server" +kubebuilder:printcolumn:name="SkipVerify",type="boolean",JSONPath=".spec.skipVerify".
WebhookList contains a list of Webhook.
WebhookSpec represents the desired state of a Webhook.

# Interfaces

TemplateObject is implemented by Template and ClusterTemplate.

# Type aliases

Action indicates what we need to do with current PipelineRun.
AddonInstallStrategy represents the addon installation strategy.
ConditionStatus is the status of the current condition.
ConditionType is type of PipelineRun condition.
LastChanges represents a set of last SCM changes.
ParameterType represents the type of parameter.
PipelineType is an alias of string that represents the type of Pipelines.
RefType indicates that SCM reference type, such as branch, tag, pr, mr.
RunPhase is a label for the condition of a PipelineRun at the current time.
StepTemplatePhase represents the phase of the Step template.
SyncWindows is a collection of sync windows in this project.