HelmRequest [app.alauda.io/v1]

类型
object
必填
spec

规格

属性类型描述
apiVersionstring

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

kindstring

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

metadataObjectMeta

ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.

specobject
statusobject

.spec

类型
object
属性类型描述
chartstring
clusterNamestring

ClusterName is the cluster where the chart will be installed. If InstallToAllClusters=true, this field will be ignored

dependenciesarray

Dependencies is the dependencies of this HelmRequest, it's a list of there names THe dependencies must lives in the same namespace, and each of them must be in Synced status before we sync this HelmRequest

installToAllClustersboolean

InstallToAllClusters will install this chart to all available clusters, even the cluster was created after this chart. If this field is true, ClusterName will be ignored(useless)

namespacestring

Namespace is the namespace where the Release object will be lived in. Notes this should be used with the values defined in the chart, otherwise the install will failed

releaseNamestring

ReleaseName is the Release name to be generated, default to HelmRequest.Name. If we want to manually install this chart to multi clusters, we may have different HelmRequest name(with cluster prefix or suffix) and same release name

sourceobject

Source defines the source of chart, If this field is set, Chart and Version field will be ignored(useless)

targetClustersobject

TargetClusters defines the target clusters which the chart will be installed

valuesobject

Values represents a collection of chart values.

valuesFromarray

ValuesFrom represents values from ConfigMap/Secret...

versionstring

.spec.dependencies

描述
Dependencies is the dependencies of this HelmRequest, it's a list of there names THe dependencies must lives in the same namespace, and each of them must be in Synced status before we sync this HelmRequest
类型
array

.spec.dependencies[]

类型
string

.spec.source

描述
Source defines the source of chart, If this field is set, Chart and Version field will be ignored(useless)
类型
object
属性类型描述
httpobject
ociobject

.spec.source.http

类型
object
必填
url
属性类型描述
secretRefstring

SecretRef A Secret reference, the secret should contain accessKeyId (user name) base64 encoded, and secretKey (password) also base64 encoded

urlstring

URL is the URL of the http(s) endpoint

.spec.source.oci

类型
object
必填
repo
属性类型描述
repostring

Repo is the repo of the oci artifact

secretRefstring

SecretRef A Secret reference, the secret should contain accessKeyId (user name) base64 encoded, and secretKey (password) also base64 encoded

.spec.targetClusters

描述
TargetClusters defines the target clusters which the chart will be installed
类型
object
属性类型描述
clusterLabelsobject

ClusterLabels store the key value of labels to match clusters

clusterNamesobject

ClusterNames store a list of cluster names

.spec.targetClusters.clusterLabels

描述
ClusterLabels store the key value of labels to match clusters
类型
object
必填
labelSelector
属性类型描述
labelSelectorobject

.spec.targetClusters.clusterLabels.labelSelector

类型
object

.spec.targetClusters.clusterNames

描述
ClusterNames store a list of cluster names
类型
object
必填
names
属性类型描述
namesarray

.spec.targetClusters.clusterNames.names

类型
array

.spec.targetClusters.clusterNames.names[]

类型
string

.spec.values

描述
Values represents a collection of chart values.
类型
object

.spec.valuesFrom

描述
ValuesFrom represents values from ConfigMap/Secret...
类型
array

.spec.valuesFrom[]

描述
ValuesFromSource represents a source of values, only one of it's fields may be set
类型
object
属性类型描述
configMapKeyRefobject

ConfigMapKeyRef selects a key of a ConfigMap

secretKeyRefobject

SecretKeyRef selects a key of a Secret

.spec.valuesFrom[].configMapKeyRef

描述
ConfigMapKeyRef selects a key of a ConfigMap
类型
object
必填
key
属性类型描述
keystring

The key to select.

namestring

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?

optionalboolean

Specify whether the ConfigMap or its key must be defined

.spec.valuesFrom[].secretKeyRef

描述
SecretKeyRef selects a key of a Secret
类型
object
必填
key
属性类型描述
keystring

The key of the secret to select from. Must be a valid secret key.

namestring

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?

optionalboolean

Specify whether the Secret or its key must be defined

.status

类型
object
属性类型描述
conditionsarray
lastSpecHashstring

LastSpecHash store the has value of the synced spec, if this value not equal to the current one, means we need to do a update for the chart

notesstring

Notes is the contents from helm (after helm install successfully it will be printed to the console

phasestring

HelmRequestPhase is a label for the condition of a HelmRequest at the current time.

reasonstring

Reason will store the reason why the HelmRequest deploy failed

syncedClustersarray

SyncedClusters will store the synced clusters if InstallToAllClusters is true

targetClusterSyncResultsobject

TargetClusterSyncResults will store the chart sync result of every target cluster

versionstring

Verions is the real version that installed

.status.conditions

类型
array

.status.conditions[]

类型
object
属性类型描述
lastProbeTimestring

Last time we probed the condition.

lastTransitionTimestring

Last time the condition transitioned from one status to another.

messagestring

Human-readable message indicating details about last transition.

reasonstring

Unique, one-word, CamelCase reason for the condition's last transition.

statusstring

Status is the status of the condition. Can be True, False, Unknown. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-conditions

typestring

Type is the type of the condition. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-conditions

.status.syncedClusters

描述
SyncedClusters will store the synced clusters if InstallToAllClusters is true
类型
array

.status.syncedClusters[]

类型
string

.status.targetClusterSyncResults

描述
TargetClusterSyncResults will store the chart sync result of every target cluster
类型
object

API 端点

可用的 API 端点如下:

  • /apis/app.alauda.io/v1/namespaces/{namespace}/helmrequests
    • DELETE: delete collection of HelmRequest
    • GET: list objects of kind HelmRequest
    • POST: create a new HelmRequest
  • /apis/app.alauda.io/v1/namespaces/{namespace}/helmrequests/{name}
    • DELETE: delete the specified HelmRequest
    • GET: read the specified HelmRequest
    • PATCH: partially update the specified HelmRequest
    • PUT: replace the specified HelmRequest
  • /apis/app.alauda.io/v1/namespaces/{namespace}/helmrequests/{name}/status
    • GET: read status of the specified HelmRequest
    • PATCH: partially update status of the specified HelmRequest
    • PUT: replace status of the specified HelmRequest

/apis/app.alauda.io/v1/namespaces/{namespace}/helmrequests

HTTP 方法
DELETE
描述
delete collection of HelmRequest
HTTP 响应
HTTP 状态码响应体
200 - OKStatus schema
401 - UnauthorizedEmpty
HTTP 方法
GET
描述
list objects of kind HelmRequest
HTTP 响应
HTTP 状态码响应体
200 - OKHelmRequestList schema
401 - UnauthorizedEmpty
HTTP 方法
POST
描述
create a new HelmRequest
查询参数
参数类型描述
dryRunstringWhen 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
fieldValidationstringfieldValidation 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.
请求体参数
参数类型描述
bodyHelmRequest schemaapplication/json formatted
HTTP 响应
HTTP 状态码响应体
200 - OKHelmRequest schema
201 - CreatedHelmRequest schema
202 - AcceptedHelmRequest schema
401 - UnauthorizedEmpty

/apis/app.alauda.io/v1/namespaces/{namespace}/helmrequests/{name}

HTTP 方法
DELETE
描述
delete the specified HelmRequest
查询参数
参数类型描述
dryRunstringWhen 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 响应
HTTP 状态码响应体
200 - OKStatus schema
202 - AcceptedStatus schema
401 - UnauthorizedEmpty
HTTP 方法
GET
描述
read the specified HelmRequest
HTTP 响应
HTTP 状态码响应体
200 - OKHelmRequest schema
401 - UnauthorizedEmpty
HTTP 方法
PATCH
描述
partially update the specified HelmRequest
查询参数
参数类型描述
dryRunstringWhen 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
fieldValidationstringfieldValidation 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 响应
HTTP 状态码响应体
200 - OKHelmRequest schema
401 - UnauthorizedEmpty
HTTP 方法
PUT
描述
replace the specified HelmRequest
查询参数
参数类型描述
dryRunstringWhen 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
fieldValidationstringfieldValidation 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.
请求体参数
参数类型描述
bodyHelmRequest schemaapplication/json formatted
HTTP 响应
HTTP 状态码响应体
200 - OKHelmRequest schema
201 - CreatedHelmRequest schema
401 - UnauthorizedEmpty

/apis/app.alauda.io/v1/namespaces/{namespace}/helmrequests/{name}/status

HTTP 方法
GET
描述
read status of the specified HelmRequest
HTTP 响应
HTTP 状态码响应体
200 - OKHelmRequest schema
401 - UnauthorizedEmpty
HTTP 方法
PATCH
描述
partially update status of the specified HelmRequest
查询参数
参数类型描述
dryRunstringWhen 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
fieldValidationstringfieldValidation 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 响应
HTTP 状态码响应体
200 - OKHelmRequest schema
401 - UnauthorizedEmpty
HTTP 方法
PUT
描述
replace status of the specified HelmRequest
查询参数
参数类型描述
dryRunstringWhen 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
fieldValidationstringfieldValidation 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.
请求体参数
参数类型描述
bodyHelmRequest schemaapplication/json formatted
HTTP 响应
HTTP 状态码响应体
200 - OKHelmRequest schema
201 - CreatedHelmRequest schema
401 - UnauthorizedEmpty