Skip to content

HelmChartRepository [helm.openshift.io/v1beta1]

Description

HelmChartRepository holds cluster-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 string 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 string 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
metadata ObjectMeta Standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
spec object spec holds user settable values for configuration
status object Observed status of the repository within the cluster..

.spec

Description
spec holds user settable values for configuration
Type
`object`
Property Type Description
connectionConfig object Required configuration for connecting to the chart repo
description string Optional human readable repository description, it can be used by UI for displaying purposes
disabled boolean If set to true, disable the repo usage in the cluster/namespace
name string 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
ca object 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 config map is openshift-config.
tlsClientConfig object 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 is openshift-config.
url string Chart repository URL

.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 config map is openshift-config.
Type
`object`
Required
  • name
Property Type Description
name string 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 is openshift-config.
Type
`object`
Required
  • name
Property Type Description
name string name is the metadata.name of the referenced secret

.status

Description
Observed status of the repository within the cluster..
Type
`object`
Property Type Description
conditions array conditions is a list of conditions and their statuses
conditions[] object Condition contains details for one aspect of the current state of this API Resource.

.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.
Type
`object`
Required
  • lastTransitionTime
  • message
  • reason
  • status
  • type
Property Type Description
lastTransitionTime string 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 string message is a human readable message indicating details about the transition. This may be an empty string.
observedGeneration integer 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 string 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 string status of the condition, one of True, False, Unknown.
type string type of condition in CamelCase or in foo.example.com/CamelCase.

API endpoints

The following API endpoints are available:

  • /apis/helm.openshift.io/v1beta1/helmchartrepositories

    • DELETE: delete collection of HelmChartRepository
    • GET: list objects of kind HelmChartRepository
    • POST: create a HelmChartRepository

  • /apis/helm.openshift.io/v1beta1/helmchartrepositories/{name}

    • DELETE: delete a HelmChartRepository
    • GET: read the specified HelmChartRepository
    • PATCH: partially update the specified HelmChartRepository
    • PUT: replace the specified HelmChartRepository

  • /apis/helm.openshift.io/v1beta1/helmchartrepositories/{name}/status

    • GET: read status of the specified HelmChartRepository
    • PATCH: partially update status of the specified HelmChartRepository
    • PUT: replace status of the specified HelmChartRepository

/apis/helm.openshift.io/v1beta1/helmchartrepositories

HTTP method
`DELETE`
Description
delete collection of HelmChartRepository

HTTP responses

HTTP code Reponse body
200 - OK Status schema
401 - Unauthorized Empty
HTTP method
`GET`
Description
list objects of kind HelmChartRepository

HTTP responses

HTTP code Reponse body
200 - OK HelmChartRepositoryList schema
401 - Unauthorized Empty
HTTP method
`POST`
Description
create a HelmChartRepository

Query parameters

Parameter Type Description
dryRun string 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 string 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.

Body parameters

Parameter Type Description
body HelmChartRepository schema

HTTP responses

HTTP code Reponse body
200 - OK HelmChartRepository schema
201 - Created HelmChartRepository schema
202 - Accepted HelmChartRepository schema
401 - Unauthorized Empty

/apis/helm.openshift.io/v1beta1/helmchartrepositories/{name}

Global path parameters

Parameter Type Description
name string name of the HelmChartRepository
HTTP method
`DELETE`
Description
delete a HelmChartRepository

Query parameters

Parameter Type Description
dryRun string 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 responses

HTTP code Reponse body
200 - OK Status schema
202 - Accepted Status schema
401 - Unauthorized Empty
HTTP method
`GET`
Description
read the specified HelmChartRepository

HTTP responses

HTTP code Reponse body
200 - OK HelmChartRepository schema
401 - Unauthorized Empty
HTTP method
`PATCH`
Description
partially update the specified HelmChartRepository

Query parameters

Parameter Type Description
dryRun string 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 string 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 responses

HTTP code Reponse body
200 - OK HelmChartRepository schema
401 - Unauthorized Empty
HTTP method
`PUT`
Description
replace the specified HelmChartRepository

Query parameters

Parameter Type Description
dryRun string 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 string 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.

Body parameters

Parameter Type Description
body HelmChartRepository schema

HTTP responses

HTTP code Reponse body
200 - OK HelmChartRepository schema
201 - Created HelmChartRepository schema
401 - Unauthorized Empty

/apis/helm.openshift.io/v1beta1/helmchartrepositories/{name}/status

Global path parameters

Parameter Type Description
name string name of the HelmChartRepository
HTTP method
`GET`
Description
read status of the specified HelmChartRepository

HTTP responses

HTTP code Reponse body
200 - OK HelmChartRepository schema
401 - Unauthorized Empty
HTTP method
`PATCH`
Description
partially update status of the specified HelmChartRepository

Query parameters

Parameter Type Description
dryRun string 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 string 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 responses

HTTP code Reponse body
200 - OK HelmChartRepository schema
401 - Unauthorized Empty
HTTP method
`PUT`
Description
replace status of the specified HelmChartRepository

Query parameters

Parameter Type Description
dryRun string 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 string 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.

Body parameters

Parameter Type Description
body HelmChartRepository schema

HTTP responses

HTTP code Reponse body
200 - OK HelmChartRepository schema
201 - Created HelmChartRepository schema
401 - Unauthorized Empty