Configuration for Upgrade Job

Paremeter Default Value Description

upgrade.enabled

true

bool - Enable upgrade component or not.

upgrade.image.registry

""

string - Set the image registry for the upgrade job.

upgrade.image.repository

kse/ks-upgrade

string - Set the image repository for the upgrade job.

upgrade.image.tag

""

string - Set the image tag for the upgrade job.

upgrade.image.pullPolicy

Always

string - Set the image pull policy for the upgrade job.

upgrade.persistenceVolume.name

ks-upgrade

string - Set the persistent volume name for the upgrade job.

upgrade.persistenceVolume.storageClassName

""

string - Set the storage class name for the upgrade job.

upgrade.persistenceVolume.accessMode

ReadWriteOnce

string - Set the access mode of the persistent volume for the upgrade job.

upgrade.persistenceVolume.size

5Gi

string - Set the size of the persistent volume for the upgrade job.

upgrade.resources.limit.cpu

1

string - Set the CPU resource limit for the upgrade job.

upgrade.resources.limit.memory

1024Mi

string - Set the Memory resource limit for the upgrade job.

upgrade.resources.requests.cpu

20m

string - Set the CPU resource request for the upgrade job.

upgrade.resources.requests.memory

100Mi

string - Set the Memory resource request for the upgrade job.

Configuration for Upgrade Application

Paremeter Default Value Description

upgrade.config.storage.local.path

/tmp/ks-upgrade

string - Set the local directory used by the upgrade job to store backup data.

upgrade.config.storage.s3.endpoint

""

string - Set the endpoint for the S3-compatible object storage service used by the upgrade job to store backup data.

upgrade.config.storage.s3.region

""

string - Set the data storage region of the S3 service.

upgrade.config.storage.s3.disableSSL

false

bool - Disable SSL for S3 or not.

upgrade.config.storage.s3.forcePathStyle

false

bool - Set the S3 client to use path-style addressing for buckets or not.

upgrade.config.storage.s3.accessKeyID

""

string - Set the access key ID for S3 service account, required if credentials are not used.

upgrade.config.storage.s3.secretAccessKey

""

string - Set the secret access key for S3 service account, required if credentials are not used.

upgrade.config.storage.s3.sessionToken

""

string - Set the session token for accessing the S3 service.

upgrade.config.storage.s3.bucket

""

string - Set the S3 bucket name.

upgrade.config.download.globalRegistryUrl

oci://hub.kubesphere.com.cn/kse-extensions

string - Set the repository URL for extensions.

upgrade.config.download.file

-

System reserved configuration.

upgrade.config.download.http.timeout

20

int64 - Set the timeout for downloading extensions.

upgrade.config.download.http.caBundle

""

string - Set the base64 string of the self-signed certificates for the extension repository, with multiple self-signed certificates combined into one base64 string.

upgrade.config.download.http.insecureSkipVerify

true

bool - Skip TLS verification for the extension repository or not.

upgrade.config.download.oci

-

System reserved configuration.

upgrade.config.skipValidator

false

bool - Skip version validation for the upgrade job or not. The validation is specific to the KubeSphere version.

Configuration for Upgrade Components

Paremeter Default Value Description

upgrade.config.jobs.$ID.enabled

false

bool - Set whether to enable the component $ID to enable the upgrade job.

upgrade.config.jobs.$ID.priority

0

int - Set the upgrade priority of the component.

upgrade.config.jobs.$ID.extensionRef.name

""

string - Set the extension name.

upgrade.config.jobs.$ID.extensionRef.version

""

string - Set the extension version.