模板函数列表

Helm 包含了很多可以在模板中利用的模板函数。以下列出了具体分类:

Logic and Flow Control Functions

Helm 包括了需要逻辑和流控制函数,包括 and, coalesce, default, empty, eq, fail, ge, gt, le, lt, ne, not, and or

and

返回两个参数的and布尔值。

and .Arg1 .Arg2

or

返回两个参数的or布尔值。会返回第一个非空参数或最后一个参数。

or .Arg1 .Arg2

not

返回参数的布尔求反。

not .Arg

eq

返回参数的布尔等式(比如, Arg1 == Arg2)。

eq .Arg1 .Arg2

ne

返回参数的布尔非等式(比如 Arg1 != Arg2)。

ne .Arg1 .Arg2

lt

如果第一参数小于第二参数,返回布尔真。否则返回假(比如, Arg1 < Arg2)。

lt .Arg1 .Arg2

le

如果第一参数小于等于第二参数,返回布尔真,否则返回假(比如, Arg1 <= Arg2)。

le .Arg1 .Arg2

gt

如果第一参数大于第二参数,返回布尔真,否则返回假(比如, Arg1 > Arg2)。

gt .Arg1 .Arg2

ge

如果第一参数大于等于第二参数,返回布尔真,否则返回假。(比如, Arg1 >= Arg2)。

ge .Arg1 .Arg2

default

使用default设置一个简单的默认值。

default "foo" .Bar

上述示例中,如果.Bar是非空值,则使用它,否则会返回foo

"空"定义取决于以下类型:

  • 整型: 0
  • 字符串: ""
  • 列表: []
  • 字典: {}
  • 布尔: false
  • 以及所有的nil (或 null)

对于结构体,没有空的定义,所以结构体从来不会返回默认值。

empty

如果给定的值被认为是空的,则empty函数返回true,否则返回false。空值列举在default部分。

empty .Foo

注意在Go模板条件中,空值是为你计算出来的。这样你很少需要 if empty .Foo ,仅使用 if .Foo 即可。

fail

无条件地返回带有指定文本的空 string 或者 error。这在其他条件已经确定而模板渲染应该失败的情况下很有用。

fail "Please accept the end user license agreement"

coalesce

coalesce函数获取一个列表并返回第一个非空值。

coalesce 0 1 2

上述会返回1

此函数用于扫描多个变量或值:

coalesce .name .parent.name "Matt"

上述示例会优先检查 .name 是否为空。如果不是,就返回值。如果 空, 继续检查.parent.name。 最终,如果 .name.parent.name 都是空,就会返回 Matt

ternary

ternary函数获取两个值和一个test值。如果test值是true,则返回第一个值。如果test值是空,则返回第二个值。 这和C或其他编程语言中的的ternary运算符类似。

true test value

ternary "foo" "bar" true

或者

true | ternary "foo" "bar"

上述返回 "foo"

false test value

ternary "foo" "bar" false

或者

false | ternary "foo" "bar"

上述返回 "bar".

String Functions

Helm 包含了一下字符串函数: abbrev, abbrevboth, camelcase, cat, contains, hasPrefix, hasSuffix, indent, initials, kebabcase, lower, nindent, nospace, plural, print, printf, println, quote, randAlpha, randAlphaNum, randAscii, randNumeric, repeat, replace, shuffle, snakecase, squote, substr, swapcase, title, trim, trimAll, trimPrefix, trimSuffix, trunc, untitle, upper, wrap, 和 wrapWith

print

返回各部分组合的字符串。

print "Matt has " .Dogs " dogs"

如果可能,非字符串类型会被转换成字符串。

注意,当相邻两个参数不是字符串时会在它们之间添加一个空格。

println

print效果一样,但会在末尾新添加一行。

printf

返回参数按顺序传递的格式化字符串。

printf "%s has %d dogs." .Name .NumberDogs

占位符取决于传入的参数类型。这包括:

一般用途:

  • %v 默认格式的值
    • 当打印字典时,加号参数(%+v)可以添加字段名称
  • %% 字符百分号,不使用值

布尔值:

  • %t true或false

整型:

  • %b 二进制
  • %c the character represented by the corresponding Unicode code point
  • %d 十进制
  • %o 8进制
  • %O 带0o前缀的8进制
  • %q 安全转义的单引号字符
  • %x 16进制,使用小写字符a-f
  • %X 16进制,使用小写字符A-F
  • %U Unicode格式: U+1234; 和"U+%04X"相同

浮点数和复杂成分

  • %b 指数二次幂的无小数科学计数法,比如 -123456p-78
  • %e 科学计数法,比如: -1.234456e+78
  • %E 科学计数法,比如: -1.234456E+78
  • %f 无指数的小数,比如: 123.456
  • %F 与%f同义
  • %g %e的大指数,否则是%f
  • %G %E的大指数,否则是%F
  • %x 十六进制计数法(和两个指数的十进制幂),比如: -0x1.23abcp+20
  • %X 大写的十六进制计数法,比如: -0X1.23ABCP+20

字符串和字节切片:

  • %s 未解析的二进制字符串或切片
  • %q 安全转义的双引号字符串
  • %x 十六进制,小写,每个字节两个字符
  • %X 十六进制,大写,每个字节两个字符

切片:

  • %p 16进制的第0个元素的地址,以0x开头

trim

trim行数移除字符串两边的空格:

trim "   hello    "

上述结果为: hello

trimAll

从字符串中移除给定的字符:

trimAll "$" "$5.00"

上述结果为:5.00 (作为一个字符串)。

trimPrefix

从字符串中移除前缀:

trimPrefix "-" "-hello"

上述结果为:hello

trimSuffix

从字符串中移除后缀:

trimSuffix "-" "hello-"

上述结果为: hello

lower

将整个字符串转换成小写:

lower "HELLO"

上述结果为: hello

upper

将整个字符串转换成大写:

upper "hello"

上述结果为: HELLO

title

首字母转换成大写:

title "hello world"

上述结果为: Hello World

untitle

移除首字母大写:untitle "Hello World" 会得到 hello world.

repeat

重复字符串多次:

repeat 3 "hello"

上述结果为: hellohellohello

substr

获取字符串的子串,有三个参数:

  • start (int)
  • end (int)
  • string (string)
substr 0 5 "hello world"

上述结果为: hello

nospace

去掉字符串中的所有空格:

nospace "hello w o r l d"

上述结果为: helloworld

trunc

截断字符串。

trunc 5 "hello world"

上述结果为: hello.

trunc -5 "hello world"

上述结果为: world.

abbrev

用省略号截断字符串 (...)

参数:

  • 最大长度
  • 字符串
abbrev 5 "hello world"

上述结果为: he..., 因为将省略号算进了长度中。

abbrevboth

两边都省略

abbrevboth 5 10 "1234 5678 9123"

上述结果为: ...5678...

It takes:

  • 左侧偏移值
  • 最大长度
  • 字符串

initials

截取给定字符串每个单词的首字母,并组合在一起。

initials "First Try"

上述结果为: FT

randAlphaNum, randAlpha, randNumeric, and randAscii

这四个字符串生成加密安全的(使用 crypto/rand)的随机字符串,但是字符集合不同:

  • randAlphaNum 使用 0-9a-zA-Z
  • randAlpha 使用 a-zA-Z
  • randNumeric 使用 0-9
  • randAscii 使用所有的可打印ASCII字符

每个函数都需要一个参数:字符串的整型长度

randNumeric 3

上述会生成三个数字的字符串。

wrap

以给定列数给文字换行。

wrap 80 $someText

上述结果会以$someText在80列处换行。

wrapWith

wrapWithwrap 类似,但可以以指定字符串换行。(wrap 使用的是 \n)

wrapWith 5 "\t" "Hello World"

上述结果为: hello world (其中空格是ASCII tab字符)

contains

测试字符串是否包含在另一个字符串中:

contains "cat" "catch"

上述结果为: true 因为 catch 包含了 cat.

hasPrefix and hasSuffix

hasPrefixhasSuffix 函数测试字符串是否有给定的前缀或后缀:

hasPrefix "cat" "catch"

上述结果为: true 因为 catchcat.

quote and squote

该函数将字符串用双引号(quote) 或者单引号(squote)括起来。

cat

cat 函数将多个字符串合并成一个,用空格分隔:

cat "hello" "beautiful" "world"

上述结果为: hello beautiful world

indent

indent 以指定长度缩进给定字符串所在行,在对齐多行字符串时很有用:

indent 4 $lots_of_text

上述结果会将每行缩进4个空格。

nindent

nindent 函数和indent函数一样,但可以在字符串开头添加新行。

nindent 4 $lots_of_text

上述结果会在字符串所在行缩进4个字符,并且在开头新添加一行。

replace

执行简单的字符串替换。

需要三个参数

  • 待替换字符串
  • 要替换字符串
  • 源字符串
"I Am Henry VIII" | replace " " "-"

上述结果为: I-Am-Henry-VIII

plural

字符串复数化。

len $fish | plural "one anchovy" "many anchovies"

如上,如果字符串长度为1,则第一个参数会被打印(one anchovy)。否则,会打印第二个参数(many anchovies)。

参数包括:

  • 单数字符串
  • 复数字符串
  • 整型长度

注意: Helm 现在不支持多语言复杂的复数规则。0被认为是复数的因为英文中作为(zero anchovies) 对待。

snakecase

将驼峰写法转换成蛇形写法。

snakecase "FirstName"

上述结果为: first_name.

camelcase

将字符串从蛇形写法转换成驼峰写法。

camelcase "http_server"

上述结果为: HttpServer

kebabcase

将驼峰写法转换成烤串写法。

kebabcase "FirstName"

上述结果为: first-name.

swapcase

基于单词的算法切换字符串的大小写。

转换算法:

  • 大写字符变成小写字母
  • 首字母变成小写字母
  • 空格后或开头的小写字母转换成大写字母
  • 其他小写字母转换成大写字母
  • 通过unicode.IsSpace(char)定义空格
swapcase "This Is A.Test"

上述结果为: tHIS iS a.tEST.

shuffle

对字符串进行洗牌。

shuffle "hello"

上述hello的随机字符串可能会是oelhl

Type Conversion Functions

Helm提供了以下类型转换函数:

  • atoi: 字符串转换成整型。
  • float64: 转换成 float64
  • int: 按系统整型宽度转换成int
  • int64: 转换成 int64
  • toDecimal: 将unix八进制转换成int64
  • toString: 转换成字符串。
  • toStrings: 将列表、切片或数组转换成字符串列表。
  • toJson (mustToJson): 将列表、切片、数组、字典或对象转换成JSON。
  • toPrettyJson (mustToPrettyJson): 将列表、切片、数组、字典或对象转换成格式化JSON。
  • toRawJson (mustToRawJson): 将列表、切片、数组、字典或对象转换成HTML字符未转义的JSON。

只有atoi需要输入一个特定的类型。其他的会尝试将任何类型转换成目标类型。比如,int64可以把浮点数转换成整型,也可以把字符串转换成整型。

toStrings

给定一个类列表集合,输出字符串切片。

list 1 2 3 | toStrings

上述会将1转成"1"2转成"2",等等,然后将其作为列表返回。

toDecimal

给定一个unix八进制权限,转换成十进制。

"0777" | toDecimal

上述回将 0777 转换成 511 并返回int64的值。

toJson, mustToJson

toJson函数将内容编码为JSON字符串。如果内容无法被转换成JSON会返回空字符串。mustToJson会返回错误以防无法编码成JSON。

toJson .Item

上述结果为: .Item的JSON字符串表示。

toPrettyJson, mustToPrettyJson

toPrettyJson函数将内容编码为好看的(缩进的)JSON字符串。

toPrettyJson .Item

上述结果为: .Item的已缩进的JSON字符串表示。

toRawJson, mustToRawJson

toRawJson 函数将内容编码成包含非转义HTML字符的JSON字符串。

toRawJson .Item

上述结果为: .Item的非转义的JSON字符串表示。

Regular Expressions

Helm 包含以下正则表达式函数 regexFind(mustRegexFind), regexFindAll(mustRegexFindAll), regexMatch (mustRegexMatch), regexReplaceAll (mustRegexReplaceAll), regexReplaceAllLiteral(mustRegexReplaceAllLiteral), regexSplit (mustRegexSplit)

regexMatch, mustRegexMatch

如果输入字符串包含可匹配正则表达式任意字符串,则返回true。

regexMatch "^[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\.[A-Za-z]{2,}$" "test@acme.com"

上述结果为: true

regexMatch有问题时会出错, mustRegexMatch有问题时会向模板引擎返回错误。

regexFindAll, mustRegexFindAll

返回输入字符串匹配正则表达式的所有切片。最后一个参数表示要返回的子字符串的数量,-1表示返回所有。

regexFindAll "[2,4,6,8]" "123456789" -1

上述结果为: [2 4 6 8]

regexFindAll 有问题时会出错, mustRegexFindAll 有问题时会向模板引擎返回错误。

regexFind, mustRegexFind

返回输入字符串的第一个 (最左边的) 正则匹配。

regexFind "[a-zA-Z][1-9]" "abcd1234"

上述结果为: d1

regexFind 有问题时会出错, mustRegexFind 有问题时会向模板引擎返回错误。

regexReplaceAll, mustRegexReplaceAll

返回输入字符串的拷贝,用替换字符串替换Regexp的匹配项。在替换字符串里面, $ 标志被解释为扩展,因此对于实例来说 $1 表示第一个子匹配的文本

regexReplaceAll "a(x*)b" "-ab-axxb-" "${1}W"

上述结果为: -W-xxW-

regexReplaceAll 有问题时会出错, mustRegexReplaceAll 有问题时会向模板引擎返回错误。

regexReplaceAllLiteral, mustRegexReplaceAllLiteral

返回输入字符串的拷贝,用替换字符串替换Regexp的匹配项。匹配字符串直接替换而不是扩展。

regexReplaceAllLiteral "a(x*)b" "-ab-axxb-" "${1}"

上述结果为: -${1}-${1}-

regexReplaceAllLiteral 有问题时会出错,mustRegexReplaceAllLiteral 有问题时会向模板引擎返回错误。

regexSplit, mustRegexSplit

将输入字符串切成有表达式分隔的子字符串,并返回表达式匹配项之间的切片。最后一个参数n确定要返回的子字符串数量,-1表示返回所有匹配。

regexSplit "z+" "pizza" -1

上述结果为: [pi a]

regexSplit 有问题时会出错,mustRegexSplit 有问题时会向模板引擎返回错误。

Cryptographic and Security Functions

Helm提供了一些高级的加密函数。包括了 adler32sum, buildCustomCert, decryptAES, derivePassword, encryptAES, genCA, genPrivateKey, genSelfSignedCert, genSignedCert, htpasswd, sha1sum, 以及 sha256sum

sha1sum

sha1sum函数接收一个字符串,并计算它的SHA1摘要。

sha1sum "Hello world!"

sha256sum

sha256sum 函数接收一个字符串,并计算它的SHA256摘要。

sha256sum "Hello world!"

上述语句会以“ASCII包装”格式计算SHA 256 校验和,并安全打印出来。

adler32sum

adler32sum函数接收一个字符串,并计算它的Adler-32校验和。

adler32sum "Hello world!"

htpasswd

htpasswd 函数使用usernamepassword 生成一个密码的bcrypt哈希值。该结果可用于 Apache HTTP Server 的基础认证。

htpasswd "myUser" "myPassword"

注意,将密码直接存储在模板中并不安全。

derivePassword

derivePassword 函数可用于基于某些共享的“主密码”约束得到特定密码。这方面的算法有 详细说明

derivePassword 1 "long" "password" "user" "example.com"

注意,将这部分直接存储在模板中并不安全。

genPrivateKey

genPrivateKey 函数生成一个编码成PEM块的新私钥。

第一个参数会采用以下某个值:

  • ecdsa: 生成椭圆曲线 DSA key (P256)
  • dsa: 生成 DSA key (L2048N256)
  • rsa: 生成 RSA 4096 key

buildCustomCert

buildCustomCert 函数允许自定义证书。

会采用以下字符串参数:

  • base64 编码PEM格式证书
  • base64 编码PEM格式私钥

返回包含以下属性的整数对象:

  • Cert:PEM编码证书
  • Key: PEM编码私钥

示例:

$ca := buildCustomCert "base64-encoded-ca-crt" "base64-encoded-ca-key"

注意返回的对象可以使用这个CA传递给genSignedCert函数进行签名。

genCA

genCA 函数生成一个新的,自签名的x509 证书机构。

会采用以下参数:

  • 主体通用名 (cn)
  • 证书有效期(天)

会返回一个包含以下属性的对象:

  • Cert: PEM编码证书
  • Key: PEM编码私钥

示例:

$ca := genCA "foo-ca" 365

注意返回的对象可以使用这个CA传递给genSignedCert函数进行签名。

genSelfSignedCert

The genSelfSignedCert 函数生成一个新的,自签名的x509 证书。

会采用下列参数:

  • 主体通用名 (cn)
  • 可选IP列表;可以为空
  • 可选备用DNS名称列表;可以为空
  • 证书有效期(天)

会返回一个包含以下属性的对象:

  • Cert: PEM编码证书
  • Key: PEM编码私钥

示例:

$cert := genSelfSignedCert "foo.com" (list "10.0.0.1" "10.0.0.2") (list "bar.com" "bat.com") 365

genSignedCert

genSignedCert 通过指定的CA签名生成一个新的, x509证书

会采用以下参数:

  • 主体通用名 (cn)
  • 可选IP列表;可以为空
  • 可选备用DNS名称列表;可以为空
  • 证书有效期(天)
  • CA (查看 genCA)

示例:

$ca := genCA "foo-ca" 365
$cert := genSignedCert "foo.com" (list "10.0.0.1" "10.0.0.2") (list "bar.com" "bat.com") 365 $ca

encryptAES

encryptAES 函数使用AES-256 CBC 加密文本并返回一个base64编码字符串。

encryptAES "secretkey" "plaintext"

decryptAES

decryptAES函数接收一个AES-256 CBC编码的字符串并返回解密文本。

"30tEfhuJSVRhpG97XCuWgz2okj7L8vQ1s6V9zVUPeDQ=" | decryptAES "secretkey"

Date Functions

Helm 包含以下可以在模板中使用的函数: ago, date, dateInZone, dateModify(mustDateModify), duration, durationRound, htmlDate, htmlDateInZone, now, toDate(mustToDate), and unixEpoch

now

当前日期/时间。和其他日期函数一起使用。

ago

ago 函数返回距time.Now的以秒为单位的间隔时间。

ago .CreatedAt"

返回time.Duration的字符串格式

2h34m7s

date

date函数格式化日期

日期格式化为YEAR-MONTH-DAY:

now | date "2006-01-02"

日期格式化在Go中有 一些不同

简言之,以此为基准日期:

Mon Jan 2 15:04:05 MST 2006

将其写成你想要的格式,上面的例子中,2006-01-02 是同一个日期,却是我们需要的格式。

dateInZone

date 一样,但是和时区一起。

dateInZone "2006-01-02" (now) "UTC"

duration

将给定的秒数格式化为time.Duration

这会返回 1m35s。

duration 95

durationRound

将给定时间舍入到最重要的单位。当time.Time计算为一个自某个时刻以来的时间,字符串和time.Duration被解析为一个时间段。

这会返回2h

durationRound "2h10m5s"

这会返回3mo

durationRound "2400h10m5s"

unixEpoch

返回time.Time的unix时间戳。

now | unixEpoch

dateModify, mustDateModify

dateModify 给定一个修改日期并返回时间戳。

从当前时间减去一个小时三十分钟:

now | date_modify "-1.5h"

如果修改格式错误, dateModify会返回日期未定义。而mustDateModify会返回错误。

htmlDate

htmlDate函数用于格式化插入到HTML日期选择器输入字段的日期。

now | htmlDate

htmlDateInZone

和htmlDate一样,但多了个时区。

htmlDateInZone (now) "UTC"

toDate, mustToDate

toDate 将字符串转换成日期。第一个参数是日期格式,第二个参数是日期字符串。 如果字符串无法转换就会返回0值。mustToDate以防无法转换会返回错误。

这在你将日期字符串转换成其他格式时很有用(使用pipe)。下面的例子会将"2017-12-31" 转换成 "31/12/2017"。

toDate "2006-01-02" "2017-12-31" | date "02/01/2006"

Dictionaries and Dict Functions

Helm 提供了一个key/value存储类型称为dict("dictionary"的简称,Python中也有)。dict是无序类型。

字典的key 必须是字符串。但值可以是任意类型,甚至是另一个dictlist

不像listdict不是不可变的。setunset函数会修改字典的内容。

Helm 提供了以下函数支持使用字典: deepCopy(mustDeepCopy), dict, get, hasKey, keys, merge (mustMerge), mergeOverwrite (mustMergeOverwrite), omit, pick, pluck, set, unset,和 values

dict

通过调用dict函数并传递一个键值对列表创建字典。

下面是创建三个键值对的字典:

$myDict := dict "name1" "value1" "name2" "value2" "name3" "value 3"

get

给定一个映射和一个键,从映射中获取值。

get $myDict "name1"

上述结果为: "value1"

注意如果没有找到,会简单返回""。不会生成error。

set

使用set给字典添加一个键值对。

$_ := set $myDict "name4" "value4"

注意set 返回字典 (Go模板函数的一个要求),因此你可能需要像上面那样使用使用$_赋值来获取值。

unset

给定一个映射和key,从映射中删除这个key。

$_ := unset $myDict "name4"

set一样,需要返回字典。

注意,如果key没有找到,这个操作会简单返回,不会生成错误。

hasKey

hasKey函数会在给定字典中包含了给定key时返回true

hasKey $myDict "name1"

如果key没找到,会返回false

pluck

pluck 函数给定一个键和多个映射,并获得所有匹配项的列表:

pluck "name1" $myDict $myOtherDict

上述会返回的list包含了每个找到的值([value1 otherValue1])。

如果key在映射中 没有找到 ,列表中的映射就不会有内容(并且返回列表的长度也会小于调用pluck的字典)。

如果key是 存在的, 但是值是空值,会插入一个值。

Helm模板中的一个常见用法是使用pluck... | first 从字典集合中获取第一个匹配的键。

merge, mustMerge

将两个或多个字典合并为一个, 目标字典优先:

$newdict := merge $dest $source1 $source2

这是个深度合并操作,但不是深度拷贝操作。合并的嵌套对象是两个字典上的同一实例。如果想深度合并的同时进行深度拷贝, 合并的时候同时使用deepCopy函数,比如:

deepCopy $source | merge $dest

mustMerge 会返回错误,以防出现不成功的合并。

mergeOverwrite, mustMergeOverwrite

合并两个或多个字典,优先按照 从右到左,在目标字典中有效地覆盖值:

给定的:

dst:
  default: default
  overwrite: me
  key: true

src:
  overwrite: overwritten
  key: false

会生成:

newdict:
  default: default
  overwrite: overwritten
  key: false
$newdict := mergeOverwrite $dest $source1 $source2

这是一个深度合并操作但不是深度拷贝操作。两个字典上嵌入的对象被合并到了同一个实例中。如果你想在合并的同时进行深度拷贝, 使用deepCopy函数,比如:

deepCopy $source | mergeOverwrite $dest

mustMergeOverwrite 会返回错误,以防出现不成功的合并。

keys

keys函数会返回一个或多个dict类型中所有的key的list。由于字典是 无序的,key不会有可预料的顺序。 可以使用sortAlpha存储。

keys $myDict | sortAlpha

当提供了多个词典时,key会被串联起来。使用uniq函数和sortAlpha获取一个唯一有序的键列表。

keys $myDict $myOtherDict | uniq | sortAlpha

pick

pick函数只从字典中选择给定的键,并创建一个新的dict

$new := pick $myDict "name1" "name2"

上述结果为: {name1: value1, name2: value2}

omit

omit函数类似于pick,除它之外返回一个新的dict,所有的key 匹配给定的key。

$new := omit $myDict "name1" "name3"

上述结果为: {name2: value2}

values

values函数类似于keys,返回一个新的list包含源字典中所有的value(只支持一个字典)。

$vals := values $myDict

上述结果为: list["value1", "value2", "value 3"]。注意 values不能保证结果的顺序;如果你需要顺序, 请使用sortAlpha

deepCopy, mustDeepCopy

deepCopymustDeepCopy 函数给定一个值并深度拷贝这个值。包括字典和其他结构体。 deepCopy有问题时会出错, 而mustDeepCopy会返回一个错误给模板系统。

dict "a" 1 "b" 2 | deepCopy

字典的内部说明

dict 在Go里是作为map[string]interface{}执行的。Go开发者可以传map[string]interface{}值给上下文, 将其作为 dict 提供给模板。

Encoding functions

Helm有以下编码和解码函数:

  • b64enc/b64dec: 编码或解码 Base64
  • b32enc/b32dec: 编码或解码 Base32

Lists and List Functions

Helm 提供了一个简单的list类型,包含任意顺序的列表。类似于数组或切片,但列表是被设计用于不可变数据类型。

创建一个整型列表:

$myList := list 1 2 3 4 5

上述会生成一个列表 [1 2 3 4 5]

Helm 提供了以下列表函数: append(mustAppend), compact (mustCompact), concat, first(mustFirst), has (mustHas), initial (mustInitial), last (mustLast), prepend (mustPrepend), rest (mustRest), reverse (mustReverse), seq, slice (mustSlice), uniq (mustUniq), until, untilStep, 和 without (mustWithout)

first, mustFirst

获取列表中的第一项,使用 first

first $myList 返回 1

first 有问题时会出错,mustFirst 有问题时会向模板引擎返回错误。

rest, mustRest

获取列表的尾部内容(除了第一项外的所有内容),使用rest

rest $myList returns [2 3 4 5]

rest有问题时会出错,mustRest 有问题时会向模板引擎返回错误。

last, mustLast

使用last获取列表的最后一项:

last $myList 返回 5。这大致类似于反转列表然后调用first

initial, mustInitial

通过返回所有元素 除了最后一个元素来赞赏lastinitial $myList 返回 [1 2 3 4]

initial有问题时会出错,但是 mustInitial 有问题时会向模板引擎返回错误。

append, mustAppend

在已有列表中追加一项,创建一个新的列表。

$new = append $myList 6

上述语句会设置 $new[1 2 3 4 5 6]$myList会保持不变。

append 有问题时会出错,但 mustAppend 有问题时会向模板引擎返回错误。

prepend, mustPrepend

将元素添加到列表的前面,生成一个新的列表。

prepend $myList 0

上述语句会生成 [0 1 2 3 4 5]$myList会保持不变。

prepend 有问题时会出错,但 mustPrepend 有问题时会向模板引擎返回错误。

concat

将任意数量的列表串联成一个。

concat $myList ( list 6 7 ) ( list 8 )

上述语句会生成 [1 2 3 4 5 6 7 8]$myList 会保持不变。

reverse, mustReverse

反转给定的列表生成一个新列表。

reverse $myList

上述语句会生成一个列表: [5 4 3 2 1]

reverse 有问题时会出错,但 mustReverse 有问题时会向模板引擎返回错误。

uniq, mustUniq

生成一个移除重复项的列表。

list 1 1 1 2 | uniq

上述语句会生成 [1 2]

uniq 有问题时会出错,但 mustUniq 有问题时会向模板引擎返回错误。

without, mustWithout

without 函数从列表中过滤内容。

without $myList 3

上述语句会生成 [1 2 4 5]

一个过滤器可以过滤多个元素:

without $myList 1 3 5

这样会得到: [2 4]

without 有问题时会出错,但 mustWithout 有问题时会向模板引擎返回错误。

has, mustHas

验证列表是否有特定元素。

has 4 $myList

上述语句会返回 true, 但 has "hello" $myList 就会返回false。

has 有问题时会出错,但 mustHas 有问题时会向模板引擎返回错误。

compact, mustCompact

接收一个列表并删除空值项。

$list := list 1 "a" "foo" ""
$copy := compact $list

compact 会返回一个移除了空值(比如, "")的新列表。

compact 有问题时会出错,但 mustCompact 有问题时会向模板引擎返回错误。

slice, mustSlice

从列表中获取部分元素,使用 slice list [n] [m]。等同于 list[n:m].

  • slice $myList 返回 [1 2 3 4 5]。 等同于 myList[:]
  • slice $myList 3 返回 [4 5]等同于 myList[3:]
  • slice $myList 1 3 返回 [2 3]等同于 myList[1:3]
  • slice $myList 0 3 返回 [1 2 3]等同于 myList[:3]

slice 有问题时会出错,但 mustSlice 有问题时会向模板引擎返回错误。

until

until 函数构建一个整数范围。

until 5

上述语句会生成一个列表: [0, 1, 2, 3, 4]

对循环语句很有用: range $i, $e := until 5

untilStep

类似untiluntilStep 生成一个可计数的整型列表。但允许你定义开始,结束和步长:

untilStep 3 6 2

上述语句会生成 [3 5],从3开始,每次加2,直到大于等于6。类似于Python的 range 函数。

seq

原理和bash的 seq 命令类似。

  • 1 单个参数 (结束位置) - 会生成所有从1到包含 end 的整数。
  • 2 多个参数 (开始, 结束) - 会生成所有包含startend 的整数,递增或者递减。
  • 3 多个参数 (开始, 步长, 结束) - 会生成所有包含 startendstep递增或递减的整数。
seq 5       => 1 2 3 4 5
seq -3      => 1 0 -1 -2 -3
seq 0 2     => 0 1 2
seq 2 -2    => 2 1 0 -1 -2
seq 0 2 10  => 0 2 4 6 8 10
seq 0 -2 -5 => 0 -2 -4

Math Functions

除非另外指定,否则所有的math函数都是操作 int64 的值。

有以下math函数可用: add, add1, ceil, div, floor, len, max, min, mod, mul, round, and [sub](#sub)。

add

使用add求和。接受两个或多个输入。

add 1 2 3

add1

自增加1,使用 add1

sub

相减使用 sub

div

整除使用 div

mod

取模使用mod

mul

相乘使用mul。接受两个或多个输入。

mul 1 2 3

max

返回一组整数中最大的整数。

下列会返回3:

max 1 2 3

min

返回一组数中最小的数。

min 1 2 3 会返回 1

floor

返回小于等于输入值的最大浮点整数。

floor 123.9999 will return 123.0

ceil

返回大于等于输入值的最小浮点整数。

ceil 123.001 will return 124.0

round

返回一个四舍五入到给定小数位的数。

round 123.555555 3 will return 123.556

len

以整数返回参数的长度。

len .Arg

Network Functions

Helm提供了一个网络函数: getHostByName.

getHostByName接收一个域名返回IP地址。

getHostByName "www.google.com"会返回对应的www.google.com的地址。

File Path Functions

Helm模板函数没有访问文件系统的权限,提供了遵循文件路径规范的函数。包括 base, clean, dir, ext, 和 isAbs

base

返回最后一个元素路径。

base "foo/bar/baz"

返回 "baz"。

dir

返回目录, 去掉路径的最后一部分。因此 dir "foo/bar/baz" 返回 foo/bar

clean

清除路径

clean "foo/bar/../baz"

上述语句会清理 .. 并返回foo/baz

ext

返回文件扩展。

ext "foo.bar"

上述结果为: .bar.

isAbs

检查文件路径是否为绝对路径,使用 isAbs

Reflection Functions

Helm 提供了基本的反射工具。这有助于高级模板开发者理解特定值的基本Go类型信息。Helm是由Go编写的且是强类型的。 类型系统应用于模板中。

Go 有一些原始 类型,比如 string, slice, int64, 和 bool

Go 有一个开放的 类型 系统,允许开发者创建自己的类型。

Helm 通过 kind functionstype functions 提供了一组函数。 deepEqual 也可以用来比较值。

Kind Functions

有两个类型函数: kindOf 返回对象类型。

kindOf "hello"

上述语句返回 string。对于简单测试(比如在if块中),Kindis函数可以验证值是否为特定类型:

kindIs "int" 123

上述返回 true

Type Functions

类型处理起来稍微有点复杂,所以有三个不同的函数:

  • typeOf 返回值的基础类型: typeOf $foo
  • typeIs 类似 kindIs, 但针对type: typeIs "*io.Buffer" $myVal
  • typeIsLike 类似 typeIs,除非取消指针引用

注意: 这些都不能测试是否实现了给定的接口,因为在这之前需要提前编译接口。

deepEqual

如果两个值相比是 "deeply equal"deepEqual返回true。

也适用于非基本类型 (相较于内置的 eq)。

deepEqual (list 1 2 3) (list 1 2 3)

上述会返回 true

Semantic Version Functions

有些版本结构易于分析和比较。Helm提供了适用于 SemVer 2 版本的函数。包括 semversemverCompare。下面你也能看到使用范围和比较的细节。

semver

semver函数将字符串解析为语义版本:

$version := semver "1.2.3-alpha.1+123"

如果解析失败,会由一个错误引起模板执行中断。

$version是一个指向Version对象的指针,包含了一下属性:

  • $version.Major: 主版本号 (上面的1)
  • $version.Minor: 次版本号 (上面的2)
  • $version.Patch: 补丁版本号 (上面的3)
  • $version.Prerelease: 预发布版本号 (上面的alpha.1)
  • $version.Metadata: 构建元数据 (上面的123)
  • $version.Original: 原始版本字符串

另外,你可以使用Compare函数比较一个Version和另一个version

semver "1.4.3" | (semver "1.2.3").Compare

上面会返回 -1

返回值可以是:

  • -1 如果给定的版本大于Compare方法调用的版本
  • 1 如果Compare调用的版本更大
  • 0 如果版本相同

(注意在语义版本中,Metadata 字段在版本比较时不比较)

semverCompare

一个更健壮的比较函数是semverCompare。 这个版本支持版本范围:

  • semverCompare "1.2.3" "1.2.3" 检查精确匹配
  • semverCompare "~1.2.0" "1.2.3" 检查主要版本和次要版本,且补丁版本第二个版本是 大于等于 第一个。

SemVer函数使用 semver规划库,由Sprig作者创建。

基本比较

两个元素的比较。首先,比较字符串是以空格或逗号分隔的。然后以|| (OR)分隔。比如:">= 1.2 < 3.0.0 || >= 4.2.3" 是要比较大于等于1.2且小于等于3.0.0 或者大于等于4.2.3的。

基本比较符有:

  • =: 相等
  • !=: 不相等
  • >: 大于
  • <: 小于
  • >=: 大于等于
  • <=: 小于等于

使用预发布版本

预发布版本,对于那些不熟悉它们的人,是用于稳定版本或一般可用版本之前的软件版本。预发布版本的例子包括开发版、 alpha版、beta版,和rc版本。稳定版1.2.3的预发布版本可能是1.2.3-beta.1,按照优先顺序,预发布版本在相关版本之前发布。 比如:1.2.3-beta.1 < 1.2.3

根据语义版本指定的预发布版本可能不与对应的发行版本兼容。

预发布版本表示版本不稳定且可能不满足其相关正常版本所表示的预期兼容性要求。

使用不带预发布版本比较器约束的语义版本的比较会跳过预发布版本。比如 >=1.2.3 会跳过预发布而>=1.2.3-0会计算并查找预发布版本。

按照规范,上例中的0作为预发布的版本是因为预发布版本只能包含ASCII字母数字和连字符(以及.分隔符), with . separators),另外排序按照ASCII排序顺序。在ASCII排序中,最小的字符是0(查看 ASCII表)。

理解ASCII排序顺序很重要因为A-Z是在a-z之前,这意味着>=1.2.3-BETA 会返回 1.2.3-alpha。这里并不适合大小写敏感, 因为是按照ASCII排序规范指定顺序。

连字符范围比较

有多个方法处理范围,首先是连字符范围。像这样:

  • 1.2 - 1.4.5 等同于 >= 1.2 <= 1.4.5
  • 2.3.4 - 4.5 等同于 >= 2.3.4 <= 4.5

比较中通配符

x, X, 和 * 可用于通配符。适用于所有比较运算符。当使用=运算符时,会返回补丁级别的比较。比如:

  • 1.2.x 相当于 >= 1.2.0, < 1.3.0
  • >= 1.2.x 相当于 >= 1.2.0
  • <= 2.x 相当于 < 3
  • * 相当于 >= 0.0.0

波浪符号范围比较 (补丁版本)

波浪 (~) 比较运算符是补丁级别范围的比较,在指定次要版本和主要版本变化且没有次要版本时使,比如:

  • ~1.2.3 相当于 >= 1.2.3, < 1.3.0
  • ~1 相当于 >= 1, < 2
  • ~2.3 相当于 >= 2.3, < 2.4
  • ~1.2.x 相当于 >= 1.2.0, < 1.3.0
  • ~1.x 相当于 >= 1, < 2

插入符号比较 (主要版本)

插入符(^)比较运算是主版本级别改变时使用。在1.0.0 发布之前,次要版本充当API稳定级别版本。 当比较主要的API版本更改时,这很有用,比如:

  • ^1.2.3 相当于 >= 1.2.3, < 2.0.0
  • ^1.2.x 相当于 >= 1.2.0, < 2.0.0
  • ^2.3 相当于 >= 2.3, < 3
  • ^2.x 相当于 >= 2.0.0, < 3
  • ^0.2.3 相当于 >=0.2.3 <0.3.0
  • ^0.2 相当于 >=0.2.0 <0.3.0
  • ^0.0.3 相当于 >=0.0.3 <0.0.4
  • ^0.0 相当于 >=0.0.0 <0.1.0
  • ^0 相当于 >=0.0.0 <1.0.0

URL Functions

Helm 包含 urlParse, urlJoin, 和 urlquery 函数可以用做处理URL。

urlParse

解析URL的字符串并生成包含URL部分的字典。

urlParse "http://admin:secret@server.com:8080/api?list=false#anchor"

上述结果为: 包含URL对象的字典:

scheme:   'http'
host:     'server.com:8080'
path:     '/api'
query:    'list=false'
opaque:   nil
fragment: 'anchor'
userinfo: 'admin:secret'

这是使用Go标准库中的URL包实现的。更多信息,请查看 https://golang.org/pkg/net/url/#URL

urlJoin

将一个映射(由urlParse生成的)连接成URL字符串

urlJoin (dict "fragment" "fragment" "host" "host:80" "path" "/path" "query" "query" "scheme" "http")

上述结果会生成以下字符串:

proto://host:80/path?query#fragment

urlquery

返回作为参数传入的值的转义版本,这样就可以嵌入到URL的查询部分。

$var := urlquery "string for query"

UUID Functions

Helm 可以生成UUID v4 通用唯一ID。

uuidv4

上述结果为: 一个新的v4类型的UUID(随机生成)。

Kubernetes and Chart Functions

Helm 包含了用于 Kubernetes的函数,包括 .Capabilities.APIVersions.Has, Files, 和 lookup

lookup

lookup 用于在正在运行的集群中查找资源。当和helm template命令一起使用时会返回一个空响应。

可以在 lookup函数文档查看更多细节。

.Capabilities.APIVersions.Has

返回API版本或资源是否在集群中可用。

.Capabilities.APIVersions.Has "apps/v1"
.Capabilities.APIVersions.Has "apps/v1/Deployment"

更多信息可查看 内置对象文档

File Functions

有几个函数能使您能够访问chart中的非特殊文件。比如访问应用配置文件。请查看 模板中访问文件

注意,这里很多函数的文档是来自 Sprig。Sprig是一个适用于Go应用的函数模板库。