- ProjectHelmChartRepository [helm.openshift.io/v1beta1]
- Specification
- API endpoints
- /apis/helm.openshift.io/v1beta1/projecthelmchartrepositories
- /apis/helm.openshift.io/v1beta1/namespaces/{namespace}/projecthelmchartrepositories
- /apis/helm.openshift.io/v1beta1/namespaces/{namespace}/projecthelmchartrepositories/{name}
- /apis/helm.openshift.io/v1beta1/namespaces/{namespace}/projecthelmchartrepositories/{name}/status
ProjectHelmChartRepository [helm.openshift.io/v1beta1]
Description
ProjectHelmChartRepository holds namespace-wide configuration for proxied Helm chart repository Compatibility level 2: Stable within a major release for a minimum of 9 months or 3 minor releases (whichever is longer).
Type
object
Required
spec
Specification
Property | Type | Description |
---|---|---|
|
| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
|
| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
| Standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | |
|
| spec holds user settable values for configuration |
|
| Observed status of the repository within the namespace.. |
.spec
Description
spec holds user settable values for configuration
Type
object
Property | Type | Description |
---|---|---|
|
| Required configuration for connecting to the chart repo |
|
| Optional human readable repository description, it can be used by UI for displaying purposes |
|
| If set to true, disable the repo usage in the namespace |
|
| Optional associated human readable repository name, it can be used by UI for displaying purposes |
.spec.connectionConfig
Description
Required configuration for connecting to the chart repo
Type
object
Property | Type | Description |
---|---|---|
|
| basicAuthConfig is an optional reference to a secret by name that contains the basic authentication credentials to present when connecting to the server. The key “username” is used locate the username. The key “password” is used to locate the password. The namespace for this secret must be same as the namespace where the project helm chart repository is getting instantiated. |
|
| ca is an optional reference to a config map by name containing the PEM-encoded CA bundle. It is used as a trust anchor to validate the TLS certificate presented by the remote server. The key “ca-bundle.crt” is used to locate the data. If empty, the default system roots are used. The namespace for this configmap must be same as the namespace where the project helm chart repository is getting instantiated. |
|
| tlsClientConfig is an optional reference to a secret by name that contains the PEM-encoded TLS client certificate and private key to present when connecting to the server. The key “tls.crt” is used to locate the client certificate. The key “tls.key” is used to locate the private key. The namespace for this secret must be same as the namespace where the project helm chart repository is getting instantiated. |
|
| Chart repository URL |
.spec.connectionConfig.basicAuthConfig
Description
basicAuthConfig is an optional reference to a secret by name that contains the basic authentication credentials to present when connecting to the server. The key “username” is used locate the username. The key “password” is used to locate the password. The namespace for this secret must be same as the namespace where the project helm chart repository is getting instantiated.
Type
object
Required
name
Property | Type | Description |
---|---|---|
|
| name is the metadata.name of the referenced secret |
.spec.connectionConfig.ca
Description
ca is an optional reference to a config map by name containing the PEM-encoded CA bundle. It is used as a trust anchor to validate the TLS certificate presented by the remote server. The key “ca-bundle.crt” is used to locate the data. If empty, the default system roots are used. The namespace for this configmap must be same as the namespace where the project helm chart repository is getting instantiated.
Type
object
Required
name
Property | Type | Description |
---|---|---|
|
| name is the metadata.name of the referenced config map |
.spec.connectionConfig.tlsClientConfig
Description
tlsClientConfig is an optional reference to a secret by name that contains the PEM-encoded TLS client certificate and private key to present when connecting to the server. The key “tls.crt” is used to locate the client certificate. The key “tls.key” is used to locate the private key. The namespace for this secret must be same as the namespace where the project helm chart repository is getting instantiated.
Type
object
Required
name
Property | Type | Description |
---|---|---|
|
| name is the metadata.name of the referenced secret |
.status
Description
Observed status of the repository within the namespace..
Type
object
Property | Type | Description |
---|---|---|
|
| conditions is a list of conditions and their statuses |
|
| Condition contains details for one aspect of the current state of this API Resource. —- This struct is intended for direct use as an array at the field path .status.conditions. For example, type FooStatus struct{ // Represents the observations of a foo’s current state. // Known .status.conditions.type are: “Available”, “Progressing”, and “Degraded” // +patchMergeKey=type // +patchStrategy=merge // +listType=map // +listMapKey=type Conditions []metav1.Condition |
.status.conditions
Description
conditions is a list of conditions and their statuses
Type
array
.status.conditions[]
Description
Condition contains details for one aspect of the current state of this API Resource. —- This struct is intended for direct use as an array at the field path .status.conditions. For example, type FooStatus struct{ // Represents the observations of a foo’s current state. // Known .status.conditions.type are: “Available”, “Progressing”, and “Degraded” // +patchMergeKey=type // +patchStrategy=merge // +listType=map // +listMapKey=type Conditions []metav1.Condition json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type" protobuf:"bytes,1,rep,name=conditions"
// other fields }
Type
object
Required
lastTransitionTime
message
reason
status
type
Property | Type | Description |
---|---|---|
|
| lastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable. |
|
| message is a human readable message indicating details about the transition. This may be an empty string. |
|
| observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance. |
|
| reason contains a programmatic identifier indicating the reason for the condition’s last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty. |
|
| status of the condition, one of True, False, Unknown. |
|
| type of condition in CamelCase or in foo.example.com/CamelCase. —- Many .condition.type values are consistent across resources like Available, but because arbitrary conditions can be useful (see .node.status.conditions), the ability to deconflict is important. The regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt) |
API endpoints
The following API endpoints are available:
/apis/helm.openshift.io/v1beta1/projecthelmchartrepositories
GET
: list objects of kind ProjectHelmChartRepository
/apis/helm.openshift.io/v1beta1/namespaces/{namespace}/projecthelmchartrepositories
DELETE
: delete collection of ProjectHelmChartRepositoryGET
: list objects of kind ProjectHelmChartRepositoryPOST
: create a ProjectHelmChartRepository
/apis/helm.openshift.io/v1beta1/namespaces/{namespace}/projecthelmchartrepositories/{name}
DELETE
: delete a ProjectHelmChartRepositoryGET
: read the specified ProjectHelmChartRepositoryPATCH
: partially update the specified ProjectHelmChartRepositoryPUT
: replace the specified ProjectHelmChartRepository
/apis/helm.openshift.io/v1beta1/namespaces/{namespace}/projecthelmchartrepositories/{name}/status
GET
: read status of the specified ProjectHelmChartRepositoryPATCH
: partially update status of the specified ProjectHelmChartRepositoryPUT
: replace status of the specified ProjectHelmChartRepository
/apis/helm.openshift.io/v1beta1/projecthelmchartrepositories
HTTP method
GET
Description
list objects of kind ProjectHelmChartRepository
HTTP code | Reponse body |
---|---|
200 - OK | |
401 - Unauthorized | Empty |
/apis/helm.openshift.io/v1beta1/namespaces/{namespace}/projecthelmchartrepositories
HTTP method
DELETE
Description
delete collection of ProjectHelmChartRepository
HTTP code | Reponse body |
---|---|
200 - OK | Status schema |
401 - Unauthorized | Empty |
HTTP method
GET
Description
list objects of kind ProjectHelmChartRepository
HTTP code | Reponse body |
---|---|
200 - OK | |
401 - Unauthorized | Empty |
HTTP method
POST
Description
create a ProjectHelmChartRepository
Parameter | Type | Description |
---|---|---|
|
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
|
| fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. |
Parameter | Type | Description |
---|---|---|
| ProjectHelmChartRepository schema |
HTTP code | Reponse body |
---|---|
200 - OK | ProjectHelmChartRepository schema |
201 - Created | ProjectHelmChartRepository schema |
202 - Accepted | ProjectHelmChartRepository schema |
401 - Unauthorized | Empty |
/apis/helm.openshift.io/v1beta1/namespaces/{namespace}/projecthelmchartrepositories/{name}
Parameter | Type | Description |
---|---|---|
|
| name of the ProjectHelmChartRepository |
HTTP method
DELETE
Description
delete a ProjectHelmChartRepository
Parameter | Type | Description |
---|---|---|
|
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
HTTP code | Reponse body |
---|---|
200 - OK | Status schema |
202 - Accepted | Status schema |
401 - Unauthorized | Empty |
HTTP method
GET
Description
read the specified ProjectHelmChartRepository
HTTP code | Reponse body |
---|---|
200 - OK | ProjectHelmChartRepository schema |
401 - Unauthorized | Empty |
HTTP method
PATCH
Description
partially update the specified ProjectHelmChartRepository
Parameter | Type | Description |
---|---|---|
|
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
|
| fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. |
HTTP code | Reponse body |
---|---|
200 - OK | ProjectHelmChartRepository schema |
401 - Unauthorized | Empty |
HTTP method
PUT
Description
replace the specified ProjectHelmChartRepository
Parameter | Type | Description |
---|---|---|
|
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
|
| fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. |
Parameter | Type | Description |
---|---|---|
| ProjectHelmChartRepository schema |
HTTP code | Reponse body |
---|---|
200 - OK | ProjectHelmChartRepository schema |
201 - Created | ProjectHelmChartRepository schema |
401 - Unauthorized | Empty |
/apis/helm.openshift.io/v1beta1/namespaces/{namespace}/projecthelmchartrepositories/{name}/status
Parameter | Type | Description |
---|---|---|
|
| name of the ProjectHelmChartRepository |
HTTP method
GET
Description
read status of the specified ProjectHelmChartRepository
HTTP code | Reponse body |
---|---|
200 - OK | ProjectHelmChartRepository schema |
401 - Unauthorized | Empty |
HTTP method
PATCH
Description
partially update status of the specified ProjectHelmChartRepository
Parameter | Type | Description |
---|---|---|
|
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
|
| fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. |
HTTP code | Reponse body |
---|---|
200 - OK | ProjectHelmChartRepository schema |
401 - Unauthorized | Empty |
HTTP method
PUT
Description
replace status of the specified ProjectHelmChartRepository
Parameter | Type | Description |
---|---|---|
|
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
|
| fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. |
Parameter | Type | Description |
---|---|---|
| ProjectHelmChartRepository schema |
HTTP code | Reponse body |
---|---|
200 - OK | ProjectHelmChartRepository schema |
201 - Created | ProjectHelmChartRepository schema |
401 - Unauthorized | Empty |