Search

Chapter 22. ProjectHelmChartRepository [helm.openshift.io/v1beta1]

download PDF
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

22.1. Specification

PropertyTypeDescription

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 namespace..

22.1.1. .spec

Description
spec holds user settable values for configuration
Type
object
PropertyTypeDescription

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 namespace

name

string

Optional associated human readable repository name, it can be used by UI for displaying purposes

22.1.2. .spec.connectionConfig

Description
Required configuration for connecting to the chart repo
Type
object
PropertyTypeDescription

basicAuthConfig

object

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

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 configmap must be same as the namespace where the project helm chart repository is getting instantiated.

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 must be same as the namespace where the project helm chart repository is getting instantiated.

url

string

Chart repository URL

22.1.3. .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
PropertyTypeDescription

name

string

name is the metadata.name of the referenced secret

22.1.4. .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
PropertyTypeDescription

name

string

name is the metadata.name of the referenced config map

22.1.5. .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
PropertyTypeDescription

name

string

name is the metadata.name of the referenced secret

22.1.6. .status

Description
Observed status of the repository within the namespace..
Type
object
PropertyTypeDescription

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. --- 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 }

22.1.7. .status.conditions

Description
conditions is a list of conditions and their statuses
Type
array

22.1.8. .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
PropertyTypeDescription

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. --- 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)

22.2. 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 ProjectHelmChartRepository
    • GET: list objects of kind ProjectHelmChartRepository
    • POST: create a ProjectHelmChartRepository
  • /apis/helm.openshift.io/v1beta1/namespaces/{namespace}/projecthelmchartrepositories/{name}

    • DELETE: delete a ProjectHelmChartRepository
    • GET: read the specified ProjectHelmChartRepository
    • PATCH: partially update the specified ProjectHelmChartRepository
    • PUT: replace the specified ProjectHelmChartRepository
  • /apis/helm.openshift.io/v1beta1/namespaces/{namespace}/projecthelmchartrepositories/{name}/status

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

22.2.1. /apis/helm.openshift.io/v1beta1/projecthelmchartrepositories

HTTP method
GET
Description
list objects of kind ProjectHelmChartRepository
Table 22.1. HTTP responses
HTTP codeReponse body

200 - OK

ProjectHelmChartRepositoryList schema

401 - Unauthorized

Empty

22.2.2. /apis/helm.openshift.io/v1beta1/namespaces/{namespace}/projecthelmchartrepositories

HTTP method
DELETE
Description
delete collection of ProjectHelmChartRepository
Table 22.2. HTTP responses
HTTP codeReponse body

200 - OK

Status schema

401 - Unauthorized

Empty

HTTP method
GET
Description
list objects of kind ProjectHelmChartRepository
Table 22.3. HTTP responses
HTTP codeReponse body

200 - OK

ProjectHelmChartRepositoryList schema

401 - Unauthorized

Empty

HTTP method
POST
Description
create a ProjectHelmChartRepository
Table 22.4. Query parameters
ParameterTypeDescription

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.

Table 22.5. Body parameters
ParameterTypeDescription

body

ProjectHelmChartRepository schema

 
Table 22.6. HTTP responses
HTTP codeReponse body

200 - OK

ProjectHelmChartRepository schema

201 - Created

ProjectHelmChartRepository schema

202 - Accepted

ProjectHelmChartRepository schema

401 - Unauthorized

Empty

22.2.3. /apis/helm.openshift.io/v1beta1/namespaces/{namespace}/projecthelmchartrepositories/{name}

Table 22.7. Global path parameters
ParameterTypeDescription

name

string

name of the ProjectHelmChartRepository

HTTP method
DELETE
Description
delete a ProjectHelmChartRepository
Table 22.8. Query parameters
ParameterTypeDescription

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

Table 22.9. HTTP responses
HTTP codeReponse body

200 - OK

Status schema

202 - Accepted

Status schema

401 - Unauthorized

Empty

HTTP method
GET
Description
read the specified ProjectHelmChartRepository
Table 22.10. HTTP responses
HTTP codeReponse body

200 - OK

ProjectHelmChartRepository schema

401 - Unauthorized

Empty

HTTP method
PATCH
Description
partially update the specified ProjectHelmChartRepository
Table 22.11. Query parameters
ParameterTypeDescription

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.

Table 22.12. HTTP responses
HTTP codeReponse body

200 - OK

ProjectHelmChartRepository schema

401 - Unauthorized

Empty

HTTP method
PUT
Description
replace the specified ProjectHelmChartRepository
Table 22.13. Query parameters
ParameterTypeDescription

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.

Table 22.14. Body parameters
ParameterTypeDescription

body

ProjectHelmChartRepository schema

 
Table 22.15. HTTP responses
HTTP codeReponse body

200 - OK

ProjectHelmChartRepository schema

201 - Created

ProjectHelmChartRepository schema

401 - Unauthorized

Empty

22.2.4. /apis/helm.openshift.io/v1beta1/namespaces/{namespace}/projecthelmchartrepositories/{name}/status

Table 22.16. Global path parameters
ParameterTypeDescription

name

string

name of the ProjectHelmChartRepository

HTTP method
GET
Description
read status of the specified ProjectHelmChartRepository
Table 22.17. HTTP responses
HTTP codeReponse body

200 - OK

ProjectHelmChartRepository schema

401 - Unauthorized

Empty

HTTP method
PATCH
Description
partially update status of the specified ProjectHelmChartRepository
Table 22.18. Query parameters
ParameterTypeDescription

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.

Table 22.19. HTTP responses
HTTP codeReponse body

200 - OK

ProjectHelmChartRepository schema

401 - Unauthorized

Empty

HTTP method
PUT
Description
replace status of the specified ProjectHelmChartRepository
Table 22.20. Query parameters
ParameterTypeDescription

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.

Table 22.21. Body parameters
ParameterTypeDescription

body

ProjectHelmChartRepository schema

 
Table 22.22. HTTP responses
HTTP codeReponse body

200 - OK

ProjectHelmChartRepository schema

201 - Created

ProjectHelmChartRepository schema

401 - Unauthorized

Empty

Red Hat logoGithubRedditYoutubeTwitter

Learn

Try, buy, & sell

Communities

About Red Hat Documentation

We help Red Hat users innovate and achieve their goals with our products and services with content they can trust.

Making open source more inclusive

Red Hat is committed to replacing problematic language in our code, documentation, and web properties. For more details, see the Red Hat Blog.

About Red Hat

We deliver hardened solutions that make it easier for enterprises to work across platforms and environments, from the core datacenter to the network edge.

© 2024 Red Hat, Inc.