Helm4Connector
The Helm v4 connector can spawn complex, multi-container environments on a Kubernetes cluster. The deployment unit is the entire Helm release, while the binding unit is the single container in a Pod. StreamFlow requires each container in a Helm release to have a unique name attribute, allowing an unambiguous identification. Finally, the scheduling unit is the single instance of a potentially replicated container in a ReplicaSet.
properties |
||
chart (required) |
A chart archive. This can be a chart reference, a path to a packaged chart, a path to an unpacked chart directory or a URL |
|
type |
string |
|
burstLimit |
Client-side default throttling limit |
|
type |
integer |
|
default |
100 |
|
caFile |
Verify certificates of HTTPS-enabled servers using this CA bundle |
|
type |
string |
|
cascade |
Selects the deletion cascading strategy for the dependents |
|
type |
string |
|
enum |
background, foreground, orphan |
|
certFile |
Identify HTTPS client using this SSL certificate file |
|
type |
string |
|
chartVersion |
Specify the exact chart version to install |
|
type |
string |
|
default |
latest |
|
commandLineValues |
Set values on the command line. Can separate values with commas: key1=val1,key2=val2 |
|
type |
string |
|
contentCache |
Path to the directory containing cached content (e.g. charts) |
|
type |
string |
|
createNamespace |
Create the release namespace if not present |
|
type |
boolean |
|
default |
False |
|
debug |
Enable verbose output |
|
type |
boolean |
|
dependencyUpdate |
Update dependencies if they are missing before installing the chart |
|
type |
boolean |
|
description |
Add a custom description to the release |
|
type |
string |
|
devel |
Use development versions, too (equivalent to version >0.0.0-0). If version is set, this is ignored |
|
type |
boolean |
|
disableOpenapiValidation |
If set, the installation process will not validate rendered templates against the Kubernetes OpenAPI Schema |
|
type |
boolean |
|
default |
False |
|
enableDns |
Enable DNS lookups when rendering templates |
|
type |
boolean |
|
default |
False |
|
fileValues |
Set values from respective files. Can separate values with commas: key1=path1,key2=path2 |
|
type |
string |
|
forceConflicts |
If set, server-side apply will force changes against field ownership conflicts |
|
type |
boolean |
|
default |
False |
|
forceReplace |
Force resource updates by replacement (delete and recreate the resource) |
|
type |
boolean |
|
default |
False |
|
generateFlag |
Generate the release name (omit the NAME parameter) |
|
type |
boolean |
|
default |
False |
|
hideNotes |
If set, do not show notes in install output. Does not affect presence in chart metadata |
|
type |
boolean |
|
default |
False |
|
inCluster |
If true, the Helm connector will use a ServiceAccount to connect to the Kubernetes cluster. This is useful when StreamFlow runs directly inside a Kubernetes Pod |
|
type |
boolean |
|
default |
False |
|
insecureSkipTLSVerify |
Skip TLS certificate checks for the chart download |
|
type |
boolean |
|
default |
False |
|
keepHistory |
Remove all associated resources and mark the release as deleted, but retain the release history |
|
type |
boolean |
|
default |
False |
|
keyFile |
Identify HTTPS client using this SSL key file |
|
type |
string |
|
keyring |
Location of public keys used for verification |
|
type |
string |
|
kubeApiserver |
The address and the port for the Kubernetes API server |
|
type |
string |
|
kubeAsGroup |
Groups to impersonate for the operation |
|
type |
string[] |
|
kubeAsUser |
Username to impersonate for the operation |
|
type |
string |
|
kubeCaFile |
The certificate authority file for the Kubernetes API server connection |
|
type |
string |
|
kubeContext |
Name of the kubeconfig context to use |
|
type |
string |
|
kubeInsecureSkipTLSVerify |
If true, the Kubernetes API server’s server certificate will not be checked for validity. This will make your Kubernetes cluster insecure |
|
type |
boolean |
|
default |
False |
|
kubeTLSServerName |
Server name to use for Kubernetes API server certificate validation. If it is not provided, the hostname used to contact the server is used |
|
type |
string |
|
kubeToken |
Bearer token for authentication |
|
type |
string |
|
kubeconfig |
Absolute path of the kubeconfig file to be used |
|
type |
string |
|
labels |
Labels to add to release metadata, divided by comma: key1=val1,key2=val2 |
|
type |
string |
|
locationsCacheTTL |
Available locations cache TTL (in seconds). When such cache expires, the connector performs a new request to check locations availability |
|
type |
integer |
|
default |
10 |
|
maxConcurrentConnections |
Maximum number of concurrent connections to open for a single Kubernetes client |
|
type |
integer |
|
default |
4096 |
|
nameTemplate |
Specify template used to name the release |
|
type |
string |
|
namespace |
Namespace to install the release into |
|
type |
string |
|
noHooks |
Prevent hooks from running during install |
|
type |
boolean |
|
output |
Print the output in the specified format |
|
type |
string |
|
enum |
json, table, yaml |
|
passCredentials |
Pass credentials to all domains |
|
type |
boolean |
|
default |
False |
|
password |
Chart repository password where to locate the requested chart |
|
type |
string |
|
plainHttp |
Use insecure HTTP connections for the chart download |
|
type |
boolean |
|
default |
False |
|
postRenderer |
The name of a post renderer type plugin to be used for post rendering. If it exists, the plugin will be used |
|
type |
string |
|
postRendererArgs |
Arguments to pass to the post-renderer (can specify multiple) |
|
type |
string[] |
|
queriesPerSecond |
Queries per second used when communicating with the Kubernetes API, not including bursting |
|
type |
float |
|
registryConfig |
Path to the registry config file |
|
type |
string |
|
releaseName |
The release name. If unspecified, it will autogenerate one for you |
|
type |
string |
|
renderSubchartNotes |
Render subchart notes along with the parent |
|
type |
boolean |
|
replace |
Reuse the given name, only if that name is a deleted release which remains in the history. This is unsafe in production |
|
type |
boolean |
|
default |
False |
|
repo |
Chart repository url where to locate the requested chart |
|
type |
string |
|
repositoryCache |
Path to the file containing cached repository indexes |
|
type |
string |
|
repositoryConfig |
Path to the file containing repository names and URLs |
|
type |
string |
|
resourcesCacheTTL |
(Deprecated. Use locationsCacheTTL.) Available resources cache TTL (in seconds). When such cache expires, the connector performs a new request to check resources availability |
|
type |
integer |
|
default |
10 |
|
rollbackOnFailure |
If set, Helm will rollback (uninstall) the installation upon failure |
|
type |
boolean |
|
default |
False |
|
serverSide |
Object updates run in the server instead of the client |
|
type |
boolean |
|
default |
True |
|
setJson |
Set JSON values on the command line (can specify multiple or separate values with commas: key1=jsonval1,key2=jsonval2) |
|
type |
string[] |
|
setLiteral |
Set a literal STRING value on the command line (can specify multiple) |
|
type |
string[] |
|
skipCrds |
If set, no CRDs will be installed |
|
type |
boolean |
|
default |
False |
|
skipSchemaValidation |
If set, disables JSON schema validation |
|
type |
boolean |
|
default |
False |
|
stringValues |
Set string values. Can separate values with commas: key1=val1,key2=val2 |
|
type |
string |
|
takeOwnership |
If set, install will ignore the check for helm annotations and take ownership of the existing resources |
|
type |
boolean |
|
default |
False |
|
timeout |
Time to wait for any individual Kubernetes operation |
|
type |
string |
|
default |
1000m |
|
transferBufferSize |
Buffer size allocated for local and remote data transfers |
|
type |
integer |
|
default |
33554431 |
|
username |
Chart repository username where to locate the requested chart |
|
type |
string |
|
verify |
Verify the package before installing it |
|
type |
boolean |
|
wait |
If specified, wait until resources are ready, up to timeout |
|
type |
string |
|
enum |
hookOnly, legacy, watcher |
|
default |
watcher |
|
waitForJobs |
If set and –wait is enabled, will wait until all Jobs have been completed before marking the release as successful. It will wait for as long as timeout |
|
type |
boolean |
|
default |
False |
|
yamlValues |
Specify values in a list of YAML files and/or URLs |
|
type |
string[] |
|