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

# Functions

No description provided by the author
Kind takes an unqualified kind and returns back a Group qualified GroupKind.
LoadRequirementsConfig loads the project configuration if there is a project configuration file if there is not a file called `jx-requirements.yml` in the given dir we will scan up the parent directories looking for the requirements file as we often run 'jx' steps in sub directories.
LoadRequirementsConfigFile loads a specific project YAML configuration file.
LoadRequirementsConfigFile loads a specific project YAML configuration file.
MissingRequirement returns an error if there is a missing property in the requirements.
NewRequirementsConfig creates a default configuration file.
Resource takes an unqualified resource and returns a Group qualified GroupResource.

# Constants

ChartRepositoryTypeNone no kind so implies a chart repository you push tarballs to like chart museum / nexus.
ChartRepositoryTypeOCI specifies that we use OCI (container images) to store charts.
ChartRepositoryTypePages specifies that we use github pages (a branch in git) to store helm charts.
DefaultFailOnValidationError by default fail if validation fails when reading jx-requirements.
Replaces the optional requirement and making jx hardcoded, if folks try changing the namespace in a jx-requirements.yml file it is highly likely to fail.
IngressTypeHTTPRoute uses the Ingress V2 / HTTPRoute resources - see: https://kubernetes-sigs.github.io/service-apis/http-routing/.
IngressTypeIngress uses the kubernetes extensions/v1 Ingress resources to create ingress.
IngressTypeIstio uses istio VirtualService resources to implement ingress instead of the extensions/v1 Ingress resources.
IngressTypeNone if we have yet to define a ingress type.
RepositoryTypeArtifactory if you wish to use Artifactory as the artifact repository.
RepositoryTypeBucketRepo if you wish to use bucketrepo as the artifact repository.
RepositoryTypeNexus if you wish to use Sonatype Nexus as the artifact repository.
RepositoryTypeNone if you do not wish to install an artifact repository.
RequirementChartRepository the helm chart repository for jx.
RequirementClusterName is the cluster name.
RequirementDevEnvApprovers contains the optional list of users to populate the dev env's OWNERS with.
RequirementEnvGitOwner the default git owner for environment repositories if none is specified explicitly.
RequirementEnvGitPublic sets the visibility of the environment repositories as private (subscription required for GitHub Organisations).
RequirementExternalDNSServiceAccountName the service account name for external dns.
RequirementGitPublic sets the visibility of the application repositories as private (subscription required for GitHub Organisations).
RequirementGkeProjectNumber is the gke project number.
RequirementIngressTLSProduction use the lets encrypt production server.
RequirementKanikoServiceAccountName the service account name for kaniko.
RequirementProject is the cloudprovider project.
RequirementRegistry the container registry for jx.
RequirementRepository the artifact repository for jx.
RequirementsConfigFileName is the name of the requirements configuration file.
RequirementSecretStorageType the secret storage type.
No description provided by the author
RequirementStorageBackupURL backup storage url.
RequirementStorageLogsURL logs storage url.
RequirementStorageReportsURL report storage url.
RequirementStorageRepositoryURL repository storage url.
RequirementVaultBucketName the vault name for vault.
RequirementVaultDisableURLDiscovery override the default lookup of the Vault URL, could be incluster service or external ingress.
RequirementVaultKeyName the key name for vault.
RequirementVaultKeyringName the keyring name for vault.
RequirementVaultName the name for vault.
RequirementVaultRecreateBucket recreate the bucket that vault uses.
RequirementVaultServiceAccountName the service account name for vault.
RequirementWebhook the webhook handler for jx.
RequirementZone zone the cluster is in.
SecretStorageTypeLocal specifies that we use the local file system in `~/.jx/localSecrets` to store secrets.
SecretStorageTypeVault specifies that we use vault to store secrets.
SettingsFileName the default file name of the settings file.
WebhookTypeLighthouse specifies that we use lighthouse for webhooks see: https://github.com/jenkins-x/lighthouse.

# Variables

AddToScheme helper.
ChartRepositoryTypeValues the string values for the secret storage.
IngressTypeValues the string values for the ingress types.
RepositoryTypeValues the string values for the repository types.
SchemeBuilder for building the schema :).
SchemeGroupVersion is group version used to register these objects.
SecretStorageTypeValues the string values for the secret storage.
WebhookTypeValues the string values for the webhook types.

# Structs

AutoUpdateConfig contains auto update config.
No description provided by the author
AzureConfig contains Azure specific requirements.
No description provided by the author
No description provided by the author
No description provided by the author
ClusterConfig contains cluster specific requirements.
DestinationConfig the common cluster settings that can be specified in settings or requirements.
EnvironmentConfig configures the organisation and repository name of the git repositories for environments.
GKEConfig contains GKE specific requirements.
IngressConfig contains dns specific requirements.
IssueTracker is currently only used for generating the changelog.
JiraTracker has settings for jira.
Deprecated: migrate to top level Requirements object.
Deprecated: migrate to top level Requirements object.
MavenRepositoryConfig contains optional configuration for maven repository configuration.
RepositoryConfig contains optional language specific repository configurations.
Requirements represents a collection installation requirements for Jenkins X +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object +k8s:openapi-gen=true.
RequirementsConfig contains the logical installation requirements in the `jx-requirements.yml` file when installing, configuring or upgrading Jenkins X via `jx boot`.
RequirementsValues contains the logical installation requirements in the `jx-requirements.yml` file as helm values.
No description provided by the author
Settings represents application specific settings for use inside a pipeline of an application +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object +k8s:openapi-gen=true.
SettingsConfig contains the optional overrides you can specify on a per application basis.
StorageConfig contains dns specific requirements.
TLSConfig contains TLS specific requirements.
UserNameEmailConfig contains the user name and email of a user (e.g.
VaultAWSConfig contains all the Vault configuration needed by Vault to be deployed in AWS.
VaultAWSUnsealConfig contains references to existing AWS resources that can be used to install Vault.
VaultAzureConfig contains all the Vault configuration needed by Vault to be deployed in Azure.
VaultConfig contains Vault configuration for Boot.

# Type aliases

ChartRepositoryType is the type of chart repository used for helm.
IngressType is the type of a ingress strategy.
RepositoryType is the type of a repository we use to store artifacts (jars, tarballs, npm packages etc).
SecretStorageType is the type of storage used for secrets.
WebhookType is the type of a webhook strategy.