Nexus Repository Manager Operator API
Packages:
edp.epam.com/v1alpha1
Resource Types:
NexusBlobStoreβ
β© ParentNexusBlobStore is the Schema for the nexusblobstores API.
Name | Type | Description | Required |
---|---|---|---|
apiVersion | string | edp.epam.com/v1alpha1 | true |
kind | string | NexusBlobStore | true |
metadata | object | Refer to the Kubernetes API documentation for the fields of the metadata field. | true |
spec | object | NexusBlobStoreSpec defines the desired state of NexusBlobStore. | false |
status | object | NexusBlobStoreStatus defines the observed state of NexusBlobStore. | false |
NexusBlobStore.specβ
β© ParentNexusBlobStoreSpec defines the desired state of NexusBlobStore.
Name | Type | Description | Required |
---|---|---|---|
name | string | Name of the BlobStore.
Name should be unique across all BlobStores. Validations: | true |
nexusRef | object | NexusRef is a reference to Nexus custom resource. | true |
file | object | File type blobstore. | false |
softQuota | object | Settings to control the soft quota. | false |
NexusBlobStore.spec.nexusRefβ
β© ParentNexusRef is a reference to Nexus custom resource.
Name | Type | Description | Required |
---|---|---|---|
name | string | Name specifies the name of the Nexus resource. | true |
kind | string | Kind specifies the kind of the Nexus resource. Default: Nexus | false |
NexusBlobStore.spec.fileβ
β© ParentFile type blobstore.
Name | Type | Description | Required |
---|---|---|---|
path | string | The path to the blobstore contents.
This can be an absolute path to anywhere on the system Nexus Repository Manager has access to it or can be a path relative to the sonatype-work directory. | false |
NexusBlobStore.spec.softQuotaβ
β© ParentSettings to control the soft quota.
Name | Type | Description | Required |
---|---|---|---|
limit | integer | The limit in MB. Format: int64 | false |
type | enum | Type of the soft quota. Enum: spaceRemainingQuota, spaceUsedQuota | false |
NexusBlobStore.statusβ
β© ParentNexusBlobStoreStatus defines the observed state of NexusBlobStore.
Name | Type | Description | Required |
---|---|---|---|
error | string | Error is an error message if something went wrong. | false |
value | string | Value is a status of the blob store. | false |
NexusCleanupPolicyβ
β© ParentNexusCleanupPolicy is the Schema for the cleanuppolicies API.
Name | Type | Description | Required |
---|---|---|---|
apiVersion | string | edp.epam.com/v1alpha1 | true |
kind | string | NexusCleanupPolicy | true |
metadata | object | Refer to the Kubernetes API documentation for the fields of the metadata field. | true |
spec | object | NexusCleanupPolicySpec defines the desired state of NexusCleanupPolicy. | false |
status | object | NexusCleanupPolicyStatus defines the observed state of NexusCleanupPolicy. | false |
NexusCleanupPolicy.specβ
β© ParentNexusCleanupPolicySpec defines the desired state of NexusCleanupPolicy.
Name | Type | Description | Required |
---|---|---|---|
criteria | object | Criteria for the cleanup policy. | true |
format | enum | Format that this cleanup policy can be applied to. Enum: apt, bower, cocoapods, conan, conda, docker, gitlfs, go, helm, maven2, npm, nuget, p2, pypi, r, raw, rubygems, yum | true |
name | string | Name is a unique name for the cleanup policy. Validations: | true |
nexusRef | object | NexusRef is a reference to Nexus custom resource. | true |
description | string | Description of the cleanup policy. | false |
NexusCleanupPolicy.spec.criteriaβ
β© ParentCriteria for the cleanup policy.
Name | Type | Description | Required |
---|---|---|---|
assetRegex | string | AssetRegex removes components that match the given regex. | false |
lastBlobUpdated | integer | LastBlobUpdated removes components published over βxβ days ago. Minimum: 1 | false |
lastDownloaded | integer | LastDownloaded removes components downloaded over βxβ days. Minimum: 1 | false |
releaseType | enum | ReleaseType removes components that are of the following release type. Enum: RELEASES, PRERELEASES, | false |
NexusCleanupPolicy.spec.nexusRefβ
β© ParentNexusRef is a reference to Nexus custom resource.
Name | Type | Description | Required |
---|---|---|---|
name | string | Name specifies the name of the Nexus resource. | true |
kind | string | Kind specifies the kind of the Nexus resource. Default: Nexus | false |
NexusCleanupPolicy.statusβ
β© ParentNexusCleanupPolicyStatus defines the observed state of NexusCleanupPolicy.
Name | Type | Description | Required |
---|---|---|---|
error | string | Error is an error message if something went wrong. | false |
value | string | Value is a status of the cleanup policy. | false |
Nexusβ
β© ParentNexus is the Schema for the nexus API.
Name | Type | Description | Required |
---|---|---|---|
apiVersion | string | edp.epam.com/v1alpha1 | true |
kind | string | Nexus | true |
metadata | object | Refer to the Kubernetes API documentation for the fields of the metadata field. | true |
spec | object | NexusSpec defines the desired state of Nexus. | false |
status | object | NexusStatus defines the observed state of Nexus. | false |
Nexus.specβ
β© ParentNexusSpec defines the desired state of Nexus.
Name | Type | Description | Required |
---|---|---|---|
secret | string | Secret is the name of the k8s object Secret related to nexus.
Secret should contain a user field with a nexus username and a password field with a nexus password. | true |
url | string | Url is the url of nexus instance. | true |
Nexus.statusβ
β© ParentNexusStatus defines the observed state of Nexus.
Name | Type | Description | Required |
---|---|---|---|
connected | boolean | Connected shows if operator is connected to nexus. | false |
error | string | Error represents error message if something went wrong. | false |
NexusRepositoryβ
β© ParentNexusRepository is the Schema for the nexusrepositories API.
Name | Type | Description | Required |
---|---|---|---|
apiVersion | string | edp.epam.com/v1alpha1 | true |
kind | string | NexusRepository | true |
metadata | object | Refer to the Kubernetes API documentation for the fields of the metadata field. | true |
spec | object | NexusRepositorySpec defines the desired state of NexusRepository.
It should contain only one format of repository - go, maven, npm, etc. and only one type - proxy, hosted or group. | false |
status | object | NexusRepositoryStatus defines the observed state of NexusRepository. | false |
NexusRepository.specβ
β© ParentNexusRepositorySpec defines the desired state of NexusRepository. It should contain only one format of repository - go, maven, npm, etc. and only one type - proxy, hosted or group.
Name | Type | Description | Required |
---|---|---|---|
nexusRef | object | NexusRef is a reference to Nexus custom resource. | true |
apt | object | false | |
bower | object | false | |
cocoapods | object | false | |
conan | object | false | |
conda | object | false | |
docker | object | false | |
gitLfs | object | false | |
go | object | false | |
helm | object | false | |
maven | object | false | |
npm | object | false | |
nuget | object | false | |
p2 | object | false | |
pypi | object | false | |
r | object | false | |
raw | object | false | |
rubyGems | object | false | |
yum | object | false |
NexusRepository.spec.nexusRefβ
β© ParentNexusRef is a reference to Nexus custom resource.
Name | Type | Description | Required |
---|---|---|---|
name | string | Name specifies the name of the Nexus resource. | true |
kind | string | Kind specifies the kind of the Nexus resource. Default: Nexus | false |
NexusRepository.spec.aptβ
β© ParentName | Type | Description | Required |
---|---|---|---|
hosted | object | false | |
proxy | object | false |
NexusRepository.spec.apt.hostedβ
β© ParentName | Type | Description | Required |
---|---|---|---|
apt | object | Apt contains data of hosted repositories of format Apt. | true |
aptSigning | object | AptSigning contains signing data of hosted repositores of format Apt. | true |
name | string | A unique identifier for this repository.
Only letters, digits, underscores(_), hyphens(-), and dots(.) are allowed and may not start with underscore or dot. | true |
cleanup | object | false | |
component | object | false | |
online | boolean | Online determines if the repository accepts incoming requests. Default: true | false |
storage | object | Storage configuration. Default: map[blobStoreName:default strictContentTypeValidation:true] | false |
NexusRepository.spec.apt.hosted.aptβ
β© ParentApt contains data of hosted repositories of format Apt.
Name | Type | Description | Required |
---|---|---|---|
distribution | string | Distribution to fetch | true |
NexusRepository.spec.apt.hosted.aptSigningβ
β© ParentAptSigning contains signing data of hosted repositores of format Apt.
Name | Type | Description | Required |
---|---|---|---|
keypair | string | PGP signing key pair (armored private key e.g. gpg --export-secret-key --armor) | true |
passphrase | string | Passphrase to access PGP signing key | false |
NexusRepository.spec.apt.hosted.cleanupβ
β© ParentName | Type | Description | Required |
---|---|---|---|
policyNames | []string | Components that match any of the applied policies will be deleted. | true |
NexusRepository.spec.apt.hosted.componentβ
β© ParentName | Type | Description | Required |
---|---|---|---|
proprietaryComponents | boolean | Components in this repository count as proprietary for namespace conflict attacks (requires Sonatype Nexus Firewall) | true |
NexusRepository.spec.apt.hosted.storageβ
β© ParentStorage configuration.
Name | Type | Description | Required |
---|---|---|---|
blobStoreName | string | Blob store used to store repository contents. Default: default | false |
strictContentTypeValidation | boolean | StrictContentTypeValidation: Whether to validate uploaded content's MIME type appropriate for the repository format. Default: true | false |
writePolicy | enum | WritePolicy controls if deployments of and updates to assets are allowed. Enum: ALLOW, ALLOW_ONCE, DENY, REPLICATION_ONLY | false |
NexusRepository.spec.apt.proxyβ
β© ParentName | Type | Description | Required |
---|---|---|---|
apt | object | Apt configuration. | true |
name | string | A unique identifier for this repository.
Only letters, digits, underscores(_), hyphens(-), and dots(.) are allowed and may not start with underscore or dot. | true |
proxy | object | Proxy configuration. | true |
cleanup | object | false | |
httpClient | object | HTTP client configuration. Default: map[autoBlock:true] | false |
negativeCache | object | Negative cache configuration. Default: map[enabled:true timeToLive:1440] | false |
online | boolean | Online determines if the repository accepts incoming requests. Default: true | false |
routingRule | string | The name of the routing rule assigned to this repository. | false |
storage | object | Storage configuration. Default: map[blobStoreName:default strictContentTypeValidation:true] | false |
NexusRepository.spec.apt.proxy.aptβ
β© ParentApt configuration.
Name | Type | Description | Required |
---|---|---|---|
distribution | string | Distribution to fetch. | true |
flat | boolean | Whether this repository is flat. Default: false | false |
NexusRepository.spec.apt.proxy.proxyβ
β© ParentProxy configuration.
Name | Type | Description | Required |
---|---|---|---|
remoteUrl | string | Location of the remote repository being proxied. | true |
contentMaxAge | integer | How long to cache artifacts before rechecking the remote repository (in minutes) Default: 1440 | false |
metadataMaxAge | integer | How long to cache metadata before rechecking the remote repository (in minutes) Default: 1440 | false |
NexusRepository.spec.apt.proxy.cleanupβ
β© ParentName | Type | Description | Required |
---|---|---|---|
policyNames | []string | Components that match any of the applied policies will be deleted. | true |
NexusRepository.spec.apt.proxy.httpClientβ
β© ParentHTTP client configuration.
Name | Type | Description | Required |
---|---|---|---|
authentication | object | HTTPClientAuthentication contains HTTP client authentication configuration data. | false |
autoBlock | boolean | Auto-block outbound connections on the repository if remote peer is detected as unreachable/unresponsive Default: true | false |
blocked | boolean | Block outbound connections on the repository. | false |
connection | object | HTTPClientConnection contains HTTP client connection configuration data. | false |
NexusRepository.spec.apt.proxy.httpClient.authenticationβ
β© ParentHTTPClientAuthentication contains HTTP client authentication configuration data.
Name | Type | Description | Required |
---|---|---|---|
ntlmDomain | string | false | |
ntlmHost | string | false | |
password | string | Password for authentication. | false |
type | enum | Type of authentication to use. Enum: username, ntlm | false |
username | string | Username for authentication. | false |
NexusRepository.spec.apt.proxy.httpClient.connectionβ
β© ParentHTTPClientConnection contains HTTP client connection configuration data.
Name | Type | Description | Required |
---|---|---|---|
enableCircularRedirects | boolean | Whether to enable redirects to the same location (required by some servers) | false |
enableCookies | boolean | Whether to allow cookies to be stored and used | false |
retries | integer | Total retries if the initial connection attempt suffers a timeout | false |
timeout | integer | Seconds to wait for activity before stopping and retrying the connection", | false |
useTrustStore | boolean | Use certificates stored in the Nexus Repository Manager truststore to connect to external systems | false |
userAgentSuffix | string | Custom fragment to append to User-Agent header in HTTP requests | false |
NexusRepository.spec.apt.proxy.negativeCacheβ
β© ParentNegative cache configuration.
Name | Type | Description | Required |
---|---|---|---|
enabled | boolean | Whether to cache responses for content not present in the proxied repository. Default: true | false |
timeToLive | integer | How long to cache the fact that a file was not found in the repository (in minutes). Default: 1440 | false |
NexusRepository.spec.apt.proxy.storageβ
β© ParentStorage configuration.
Name | Type | Description | Required |
---|---|---|---|
blobStoreName | string | Blob store used to store repository contents. Default: default | false |
strictContentTypeValidation | boolean | StrictContentTypeValidation: Whether to validate uploaded content's MIME type appropriate for the repository format. Default: true | false |
NexusRepository.spec.bowerβ
β© ParentName | Type | Description | Required |
---|---|---|---|
group | object | false | |
hosted | object | false | |
proxy | object | false |
NexusRepository.spec.bower.groupβ
β© ParentName | Type | Description | Required |
---|---|---|---|
group | object | Group configuration. | true |
name | string | A unique identifier for this repository.
Only letters, digits, underscores(_), hyphens(-), and dots(.) are allowed and may not start with underscore or dot. | true |
online | boolean | Online determines if the repository accepts incoming requests. Default: true | false |
storage | object | Storage configuration. Default: map[blobStoreName:default strictContentTypeValidation:true] | false |
NexusRepository.spec.bower.group.groupβ
β© ParentGroup configuration.
Name | Type | Description | Required |
---|---|---|---|
memberNames | []string | Member repositories' names. | true |
NexusRepository.spec.bower.group.storageβ
β© ParentStorage configuration.
Name | Type | Description | Required |
---|---|---|---|
blobStoreName | string | Blob store used to store repository contents. Default: default | false |
strictContentTypeValidation | boolean | StrictContentTypeValidation: Whether to validate uploaded content's MIME type appropriate for the repository format. Default: true | false |
NexusRepository.spec.bower.hostedβ
β© ParentName | Type | Description | Required |
---|---|---|---|
name | string | A unique identifier for this repository.
Only letters, digits, underscores(_), hyphens(-), and dots(.) are allowed and may not start with underscore or dot. | true |
cleanup | object | false | |
component | object | false | |
online | boolean | Online determines if the repository accepts incoming requests. Default: true | false |
storage | object | Storage configuration. Default: map[blobStoreName:default strictContentTypeValidation:true] | false |
NexusRepository.spec.bower.hosted.cleanupβ
β© ParentName | Type | Description | Required |
---|---|---|---|
policyNames | []string | Components that match any of the applied policies will be deleted. | true |
NexusRepository.spec.bower.hosted.componentβ
β© ParentName | Type | Description | Required |
---|---|---|---|
proprietaryComponents | boolean | Components in this repository count as proprietary for namespace conflict attacks (requires Sonatype Nexus Firewall) | true |
NexusRepository.spec.bower.hosted.storageβ
β© ParentStorage configuration.
Name | Type | Description | Required |
---|---|---|---|
blobStoreName | string | Blob store used to store repository contents. Default: default | false |
strictContentTypeValidation | boolean | StrictContentTypeValidation: Whether to validate uploaded content's MIME type appropriate for the repository format. Default: true | false |
writePolicy | enum | WritePolicy controls if deployments of and updates to assets are allowed. Enum: ALLOW, ALLOW_ONCE, DENY, REPLICATION_ONLY | false |
NexusRepository.spec.bower.proxyβ
β© ParentName | Type | Description | Required |
---|---|---|---|
bower | object | true | |
name | string | A unique identifier for this repository.
Only letters, digits, underscores(_), hyphens(-), and dots(.) are allowed and may not start with underscore or dot. | true |
proxy | object | Proxy configuration. | true |
cleanup | object | false | |
httpClient | object | HTTP client configuration. Default: map[autoBlock:true] | false |
negativeCache | object | Negative cache configuration. Default: map[enabled:true timeToLive:1440] | false |
online | boolean | Online determines if the repository accepts incoming requests. Default: true | false |
routingRule | string | The name of the routing rule assigned to this repository. | false |
storage | object | Storage configuration. Default: map[blobStoreName:default strictContentTypeValidation:true] | false |