package
1.3.1119
Repository: https://github.com/jenkins-x/jx.git
Documentation: pkg.go.dev

# Packages

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
No description provided by the author

# Functions

AddUserToConfig adds the given user to the config.
BuildJSONPatch builds JSON patch data for an entity mutation, that can then be applied to K8S as a Patch update.
CertificateAuthorityData returns the certificate authority data for the given context.
No description provided by the author
No description provided by the author
CombineVolumes combines all the given volumes together ignoring duplicates.
No description provided by the author
No description provided by the author
No description provided by the author
ContainsVolume returns true if the given volume slice contains the given volume.
ContainsVolumeMount returns true if the given volume mount slice contains the given volume.
CreateClusterRole creates a new cluster role.
CreateClusterRoleBinding creates acluster role binding in a given namespace for a service account.
CreateDefaultDevEnvironment creates a default development environment.
CreateEnvGitRepository creates the git repository for the given Environment.
CreateEnvironmentCache creates a cache for the given namespace of Environments.
CreateEnvironmentSurvey creates a Survey on the given environment using the default options from the CLI.
CreateKubeClient creates a new Kubernetes client.
CreateObjectReference create an ObjectReference from the typed and object meta stuff.
CreatePatchBytes creates a kubernetes PATCH block.
CreatePipelineDetails creates a PipelineDetails object populated from the activity.
CreateSourceRepository creates a repo.
CreateTeam creates a new default Team.
CurrentCluster returns the current cluster.
CurrentContext returns the current context.
CurrentContextName returns the current context name.
CurrentNamespace returns the current namespace in the context.
CurrentServer returns the current context's server.
DefaultModifyConfigMap default implementation of a function to modify.
DefaultModifySecret default implementation of a function to modify.
DeleteClusterRole deletes a cluster role if exists.
DeleteClusterRoleBinding deltes a cluster role binding.
DeleteIngress removes an ingress by name.
No description provided by the author
DeleteTeam deletes the team resource but does not uninstall the underlying namespaces.
No description provided by the author
EmailToK8sID converts the provided email address to a valid Kubernetes resource name, converting the @ to a .
EnableInsecureRegistry appends the Docker Registry.
EnsureDevEnvironmentSetup ensures that the Environment is created in the given namespace.
EnsureDevNamespaceCreatedWithoutEnvironment ensures that there is a development namespace created.
EnsureEditEnvironmentSetup ensures that the Environment is created in the given namespace.
No description provided by the author
EnsureGitServiceExistsForHost ensures that there is a GitService CRD for the given host and kind.
Ensure that the namespace exists for the given name.
EnvironmentMatches returns true if the environment matches the given filter.
EnvironmentMatchesAny returns true if the list of filters is empty or one of the filters matches the given environment.
No description provided by the author
ExtractDomainValue returns the domain value.
No description provided by the author
No description provided by the author
No description provided by the author
FixSchema walks the schema and automatically fixes it up to be better supported by Kubernetes.
GenerateBuildNumber generates a new build number for the given pipeline.
GetAdminNamespace tries to find the admin namespace that corresponds to this team.
GetAppName returns the app name.
No description provided by the author
GetCommandAndArgs extracts the command and arguments for the container, taking into account the entrypoint invocation if it's not an init container.
GetCommitSha returns the git commit sha.
GetCommitURL returns the git commit URL.
GetConfigMap gets a named configmap.
GetConfigMapData gets config map data.
GetConfigMaps returns a map of the ConfigMaps along with a sorted list of names.
GetContainersWithStatusAndIsInit gets the containers in the pod, either init containers or non-init depending on whether non-init containers are present, and a flag as to whether this list of containers are init containers or not.
GetCurrentDomain gets the current domain.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
GetDevEnvGitOwner gets the default GitHub owner/organisation to use for Environment repos.
GetDevEnvironment returns the current development environment using the jxClient for the given ns.
GetDevNamespace returns the developer environment namespace which is the namespace that contains the Environments and the developer tools like Jenkins.
GetDevPodNames returns the users dev pod names.
No description provided by the author
GetEditEnvironmentNamespace returns the namespace of the current users edit environment.
GetEnrichedDevEnvironment lazily creates the dev namespace if it does not already exist and auto-detects the webhook engine if its not specified.
GetEnvironment find an environment by name.
GetEnvironmentNames returns the sorted list of environment names.
GetEnvironments returns the namespace name for a given environment.
GetEnvironmentRoles returns all the environment role binding names and details.
GetEnvironments returns a map of the environments along with a sorted list of names.
GetEnvironmentsByPrURL find an environment by a pull request URL.
GetEnvVar returns the env var if its defined for the given name.
GetFilteredEnvironmentNames returns the sorted list of environment names.
GetGitServiceKind returns the kind of the given host if one can be found or "".
No description provided by the author
No description provided by the author
GetName returns the app name.
GetOrCreateRelease creates or updates the given release resource.
GetOrCreateSourceRepository gets or creates the SourceRepository for the given repository name and organisation.
GetOrCreateStage gets or creates the stage for the given name.
GetOrCreateStepInStage gets or creates the step for the given name in the given stage.
GetOrderedEnvironments returns a map of the environments along with the correctly ordered names.
GetOrderedReleases returns the releases sorted in newest release first.
GetPendingTeams returns the pending teams with the sorted order of names.
GetPermanentEnvironments returns a list with the current permanent environments.
credit https://github.com/kubernetes/kubernetes/blob/8719b4a/pkg/api/v1/pod/util.go GetPodCondition extracts the provided condition from the given status and returns that.
No description provided by the author
No description provided by the author
credit https://github.com/kubernetes/kubernetes/blob/8719b4a/pkg/api/v1/pod/util.go Extracts the pod ready condition from the given status and returns that.
GetPodRestars returns the number of restarts of a POD.
No description provided by the author
No description provided by the author
GetPodVersion returns the version for the given app name.
GetPreviewEnvironmentReleaseName returns the (helm) release name for the given (preview) environment or the empty string is the environment is not a preview environment, or has no release name associated with it.
GetQuickstartLocations returns the current quickstart locations.
No description provided by the author
GetSecrets returns a map of the Secrets along with a sorted list of names.
GetServiceKindFromSecrets gets the kind of service from secrets.
GetSliceEnvVar returns the EnvVar for the given name or nil if none exists in the slice.
GetTeamRoles returns the roles for the given team dev namespace.
GetTeams returns the Teams the user is a member of.
UpdateUserRoles updates the EnvironmentRoleBinding values based on the given userRoles userKind is "User" or "ServiceAccount".
GetVersion returns the version from the labels on the deployment if it can be deduced.
No description provided by the author
No description provided by the author
HasContainerStarted returns true if the given Container has started running.
IsClusterRole checks if a cluster role exists.
IsClusterRoleBinding checks if the cluster role binding exists.
No description provided by the author
No description provided by the author
IsJobFinished returns true if the job has completed.
IsJobSucceeded returns true if the job completed and did not fail.
IsPermanentEnvironment indicates if an environment is permanent.
credit https://github.com/kubernetes/kubernetes/blob/8719b4a/pkg/api/v1/pod/util.go IsPodReady returns true if a pod is ready; false otherwise.
credit https://github.com/kubernetes/kubernetes/blob/8719b4a/pkg/api/v1/pod/util.go IsPodReady retruns true if a pod is ready; false otherwise.
No description provided by the author
IsProwEnabled returns true if Prow is enabled in the given development namespace.
IsResourceVersionNewer returns true if the first resource version is newer than the second.
IsTektonEnabled returns true if Build Pipeline is enabled in the given development namespace.
LoadPodTemplates loads the Jenkins pod templates from the given namepace.
ModifyNamespace modifies the namespace.
NewKubeConfig creates a new KubeConfig struct to be used to interact with the underlying kube system.
NewLogMasker creates a new LogMasker loading secrets from the given namespace.
NewPermanentEnvironment creates a new permanent environment for testing.
NewPermanentEnvironment creates a new permanent environment for testing.
NewPipelineCache creates a cache of pipelines for a namespace.
NewPipelineID creates a new PipelineID for a given owner, repository, and branch.
NewPipelineIDFromString creates a new PipelineID, given a pre-built string identifier.
NewPreviewEnvironment creates a new preview environment for testing.
ParseXml parses XML.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
ReadInstallValues reads the installed configuration values from the installation namespace Empty map is returned if: - jx-install-config config map doesn't exist - kube client returns error on Config Map read operation Error is returned if: - jx-install-config config map doesn't exist - kube client returns error on Config Map read operation.
ReadRegion allows to read cloud region from Config Map (jx-install-config).
RegisterAllCRDs ensures that all Jenkins-X CRDs are registered.
RegisterAppCRD ensures that the CRD is registered for App.
RegisterBuildPackCRD ensures that the CRD is registered for BuildPack.
RegisterCommitStatusCRD ensures that the CRD is registered for CommitStatus.
RegisterCRD allows new custom resources to be registered using apiClient under a particular name.
RegisterEnvironmentCRD ensures that the CRD is registered for Environments.
RegisterEnvironmentRoleBindingCRD ensures that the CRD is registered for Environments.
RegisterExtensionCRD ensures that the CRD is registered for Extension.
RegisterFactCRD ensures that the CRD is registered for Fact.
RegisterGitServiceCRD ensures that the CRD is registered for GitServices.
RegisterPipelineActivityCRD ensures that the CRD is registered for PipelineActivity.
RegisterPipelineStructureCRD ensures that the CRD is registered for PipelineStructure.
RegisterPluginCRD ensures that the CRD is registered for Plugin.
RegisterReleaseCRD ensures that the CRD is registered for Release.
RegisterSourceRepositoryCRD ensures that the CRD is registered for Applications.
RegisterTeamCRD ensures that the CRD is registered for Team.
RegisterUserCRD ensures that the CRD is registered for User.
RegisterWorkflowCRD ensures that the CRD is registered for Environments.
RememberInstallValues remembers any non-blank installation values in the Kubernetes Config Map (jx-install-config), so jx can access this information later.
RememberRegion remembers cloud providers region in Kubernetes Config Map (jx-install-config), so jx can access this information later.
ReplaceMakeVariable needs a description.
No description provided by the author
No description provided by the author
No description provided by the author
SaveAsConfigMap to the specified namespace as a config map.
Server returns the server of the given context.
No description provided by the author
SetAdminNamespace annotates the given namespace with a backlink to the admin namespace.
No description provided by the author
No description provided by the author
SortReleases sorts the releases in name order then latest version first.
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
ToMetaTime converts the go time pointer to a meta time.
ToValidImageName converts the given string into a valid docker image name.
ToValidImageVersion converts the given string into a valid docker image version string.
ToValidName converts the given string into a valid Kubernetes resource name.
ToValidNameTruncated converts the given string into a valid Kubernetes resource name, truncating the result if it is more than maxLength characters.
ToValidNameWithDots converts the given string into a valid Kubernetes resource name.
UpdateJenkinsGitServers update the Jenkins ConfigMap with any missing Git server configurations for the given server and token.
UpdateUserRoles updates the EnvironmentRoleBinding values based on the given userRoles.
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
No description provided by the author
WaitForDeploymentToBeReady waits for the pods of a deployment to become ready.
WaitForJobToComplete waits for the job to complete.
waits for the job to complete.
waits for the pod to become ready using the pod name.
waits for the pod to become ready using label selector to match the pod.

# Constants

AnnotationCredentialsDescription the description text for a Credential on a Secret.
AnnotationDescription the tooltip / texual description of an resource.
AnnotationExpose used to expose service using exposecontroller.
AnnotationExposePort indicates to the exposecontroller which service port to exposein case a service has multiple prots.
AnnotationIngress tells exposecontroller to annotate generated ingress rule with values.
AnnotationIsDefaultStorageClass used to indicate a storageclass is default.
AnnotationLocalDir the local directory that is sync'd to the DevPod.
AnnotationName indicates a service/server's textual name (can be mixed case, contain spaces unlike Kubernetes resources).
AnnotationReleaseName is the name of the annotation that stores the release name in the preview environment.
AnnotationTitle the human readable name of a resource which can include mixed case, spaces and punctuation.
AnnotationURL indicates a service/server's URL.
AnnotationWorkingDir the working directory, such as for a DevPod.
No description provided by the author
No description provided by the author
ChartAmbassador the default chart for ambassador.
ChartAnchore the default chart for the Anchore plugin.
ChartBuildTemplates the build templates for Knative Build.
ChartCloudBees the default name of the CloudBees addon chart.
ChartExposecontrollerService the default name of the Exposecontroller Service chart for Edit environments.
ChartFlagger the default chart for the Flagger chart.
No description provided by the author
ChartGitea the default name of the gitea chart.
ChartIstio the default chart for the Istio chart.
ChartKnative the default chart for knative.
ChartKubeless the default chart for kubeless.
ChartAnchore the default chart for the Anchore plugin.
ChartProw the default chart for Prow.
No description provided by the author
Charts Single Sign-On addon.
ChartTekton the default chart for tekton.
ChartVaultOperator the default chart for vault opeator.
ClassificationCoverage stores code coverage results/reports.
ClassificationLogs stores build logs.
ClassificationTest stores test results/rports.
ClusterName stores the name of the cluster that is created.
ConfigMapExposecontroller the name of the ConfigMap with the Exposecontroller configuration.
ConfigMapIngressConfig the new name of the ConfigMap with the Exposecontroller configuration.
ConfigMapJenkinsDockerRegistry is the ConfigMap containing the Docker Registry configuration.
ConfigMapJenkinsPodTemplates is the ConfigMap containing all the Pod Templates available.
ConfigMapJenkinsTeamController is the ConfigMap containing the TeamController config files.
ConfigMapJenkinsX the name of the ConfigMap with the Jenkins configuration.
ConfigMapNameJXInstallConfig is the ConfigMap containing the jx installation's CA and server url.
DefaultBuildTemplatesReleaseName the default helm release name for the knative build templates.
DefaultChartMuseumURL default URL for Jenkins X Charts.
No description provided by the author
No description provided by the author
DefaultKnativeBuildReleaseName the default helm release name for knative build.
DefaultNamespace the standard namespace for Jenkins X.
No description provided by the author
DefaultProwReleaseName the default helm release name for Prow.
No description provided by the author
No description provided by the author
DefaultTektonReleaseName the default helm release name for tekton.
No description provided by the author
DeploymentExposecontrollerService the name of the Deployment for the Exposecontroller Service.
DeploymentProwBuild the name of the Deployment for the Prow webhook engine.
DeploymentTektonController the name of the Deployment for the Tekton Pipeline controller.
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
No description provided by the author
JenkinsAdminApiToken the API token.
JenkinsAdminPasswordField the password field.
JenkinsAdminUserField the admin user name.
JenkinsBearTokenField the bearer token.
LabelCreatedBy indicates the service that created this resource.
LabelCredentialsType the kind of jenkins credential for a secret.
LabelDevPodName the name of a dev pod.
LabelDevPodUsername the user name owner of the DeVPod.
LabelEnvironment indicates the name of the environment.
LabelJobKind the kind of job.
LabelKind to indicate the kind of auth, such as Git or Issue.
LabelPodTemplate the name of the pod template for a DevPod.
LabelServiceKind the label to indicate the auto Server's Kind.
LabelTeam indicates the team name an environment belongs to.
LabelUsername the user name owner of a namespace or resource.
LabelValueDevEnvironment is the value of the LabelTeam label for Development environments (system namespace).
LocalHelmRepoName is the default name of the local chart repository where CI/CD releases go to.
No description provided by the author
No description provided by the author
PodNamespaceFile the file path and name for pod namespace.
ProjectID stores the project ID used to install the cluster (a GKE thing mostly).
Region stores the cloud region the cluster is installed on.
SecretBasicAuth the name for the Jenkins X basic auth secret.
SecretDataPassword the password in a Secret/Credentials.
SecretDataUsername the username in a Secret/Credentials.
SecretJenkins is the name of the Jenkins secret.
SecretJenkinsChartMuseum the chart museum secret.
SecretJenkinsPipelineAddonCredentials the chat credentials secret.
SecretJenkinsPipelineChatCredentials the chat credentials secret.
SecretJenkinsPipelineGitCredentials the git credentials secret.
SecretJenkinsPipelineIssueCredentials the issue tracker credentials secret.
SecretJenkinsPipelinePrefix prefix for a jenkins pipeline secret name.
SecretJenkinsReleaseGPG the GPG secrets for doing releases.
ServiceChartMuseum the service name of the Helm ChartMuseum service.
ServiceCloudBees the service name of the CloudBees app for Kubernetes.
ServiceJenkins is the name of the Jenkins Service.
ServiceKubernetesDashboard the Kubernetes dashboard.
SystemVaultName stores the name of the system Vault created on install.
No description provided by the author
No description provided by the author
ValueCreatedByJX for resources created by the Jenkins X CLI.
ValueCredentialTypeSecretFile for secret files.
ValueCredentialTypeUsernamePassword for user password credential secrets.
ValueJobKindPostPreview.
ValueKindAddon an addon auth secret/credentials.
ValueKindChat a chat auth secret/credentials.
ValueKindCVE an CVS App secret/credentials.
ValueKindEditNamespace for edit namespace.
ValueKindEnvironmentRole to indicate a Role which maps to an EnvironmentRoleBinding.
ValueKindGit a git auth secret/credentials.
ValueKindIssue an issue auth secret/credentials.
ValueKindJenkins an Jenkins App secret/credentials.
ValueKindCVE an addon auth PipelineEvent.
ValueKindPodTemplate a PodTemplate in a ConfigMap.
ValueKindPodTemplateXML a PodTemplate XML in a ConfigMap.
ValueKindCVE an addon auth PipelineEvent.
Zone stores the cloud zone of the install.

# Variables

No description provided by the author
No description provided by the author
Classifications the common classification names.
ClassificationValues the classification values as a string.
No description provided by the author

# Structs

No description provided by the author
EnvironmentNamespaceCache caches the Environments for a single namespace.
No description provided by the author
No description provided by the author
JXInstallConfig is the struct used to create the jx-install-config configmap.
KubeConfig implements kube interactions.
LogMasker replaces words in a log from a set of secrets.
No description provided by the author
ObjectReference represents a reference to a k8s resource.
PatchRow used to generate the patch JSON for patching.
No description provided by the author
No description provided by the author
PipelineID is an identifier for a Pipeline.
PipelineNamespaceCache caches the pipelines for a single namespace.
No description provided by the author

# Interfaces

Kuber defines common kube actions used within Jenkins Xgo:generate pegomock generate github.com/jenkins-x/jx/pkg/kube Kuber -o mocks/kuber.go.

# Type aliases

No description provided by the author
No description provided by the author
PatchModifier is a function that is function that mutates an entity during JSON patch generation.
No description provided by the author
No description provided by the author
No description provided by the author