Skip to content

Commit e8f65c1

Browse files
committed
update kots temp func docs with ecv3 limitations
1 parent 122f35c commit e8f65c1

2 files changed

Lines changed: 38 additions & 11 deletions

File tree

docs/reference/template-functions-about.mdx

Lines changed: 18 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ This topic describes Replicated template functions, including information about
1212

1313
## Overview
1414

15-
For Kubernetes manifest files for applications deployed by a Replicated installer (Embedded Cluster, KOTS, kURL), Replicated provides a set of custom template functions based on the Go text/template library.
15+
Replicated provides a set of custom template functions based on the Go text/template library. You can use the Replicated template functions in Kubernetes manifest files for applications deployed by a Replicated installer (Embedded Cluster, KOTS, kURL).
1616

1717
<UseCases/>
1818

@@ -26,16 +26,6 @@ You can use Replicated template functions in Kubernetes manifest files for appli
2626
* Kubernetes objects like Deployments, Services, Secrets, or ConfigMaps
2727
* Kubernetes Operators
2828

29-
### Limitations
30-
31-
* Not all fields in the Config and Application custom resources support templating. For more information, see [Application](/reference/custom-resource-application) and [Item Properties](/reference/custom-resource-config#item-properties) in _Config_.
32-
33-
* Templating is not supported in the [Embedded Cluster Config](/embedded-cluster/v3/embedded-config) resource.
34-
35-
* Replicated template functions are not directly supported in Helm charts. For more information, see [Helm Charts](#helm-charts) below.
36-
37-
### Helm charts
38-
3929
Replicated template functions are _not_ directly supported in Helm charts. However, the HelmChart custom resource provides a way to map values rendered by Replicated template functions to Helm chart values. This allows you to use Replicated template functions with Helm charts without making changes to those Helm charts.
4030

4131
For information about how to map values from the HelmChart custom resource to Helm chart `values.yaml` files, see [Setting Helm Chart Values with KOTS](/vendor/helm-optional-value-keys).
@@ -46,6 +36,23 @@ During application installation and upgrade, KOTS templates all Kubernetes manif
4636

4737
For the [Config](/reference/custom-resource-config) custom resource, KOTS templates each item separately so that config items can be used in templates for other items. For examples of this, see [Using Conditional Statements in Configuration Fields](/vendor/config-screen-conditional) and [Template Function Examples](/reference/template-functions-examples).
4838

39+
### Limitations
40+
41+
* Not all fields in the Config and Application custom resources support templating. For more information, see [Application](/reference/custom-resource-application) and [Item Properties](/reference/custom-resource-config#item-properties) in _Config_.
42+
43+
* Templating is not supported in the [Embedded Cluster Config](/embedded-cluster/v3/embedded-config) resource.
44+
45+
* Replicated template functions are not directly supported in Helm charts. For more information, see [Helm Charts](#helm-charts) on this page.
46+
47+
* Embedded Cluster v3 does not support the following template functions:
48+
* HasLocalRegistry
49+
* LocalRegistryAddress
50+
* LocalRegistryHost
51+
* LocalRegistryNamespace
52+
* LocalImageName
53+
54+
These template functions are typically used to conditionally rewrite image references in air gap installations to reference the local image registry. For Embedded Cluster v3 installations, use the ReplicatedImageName, ReplicatedImageName, and ReplicatedImageName template functions instead. For more information, see [Template Functions for Embedded Cluster (Beta)](/embedded-cluster/v3/template-functions).
55+
4956
## Syntax {#syntax}
5057

5158
The Replicated template function syntax supports the following functionally equivalent delimiters:

docs/reference/template-functions-config-context.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -194,6 +194,10 @@ Returns true if the configuration option value is not equal to the supplied valu
194194
195195
## LocalRegistryAddress
196196
197+
:::note
198+
The LocalRegistryAddress template function is not supported for installations with Embedded Cluster v3. See [Template Functions for Embedded Cluster (Beta)](/embedded-cluster/v3/template-functions).
199+
:::
200+
197201
```go
198202
func LocalRegistryAddress() string
199203
```
@@ -203,6 +207,10 @@ This will always return everything before the image name and tag.
203207

204208
## LocalRegistryHost
205209

210+
:::note
211+
The LocalRegistryHost template function is not supported for installations with Embedded Cluster v3. See [Template Functions for Embedded Cluster (Beta)](/embedded-cluster/v3/template-functions).
212+
:::
213+
206214
```go
207215
func LocalRegistryHost() string
208216
```
@@ -236,6 +244,10 @@ For more information, see [Set Helm Values with KOTS](/vendor/helm-optional-valu
236244

237245
## LocalRegistryNamespace
238246

247+
:::note
248+
The LocalRegistryNamespace template function is not supported for installations with Embedded Cluster v3. See [Template Functions for Embedded Cluster (Beta)](/embedded-cluster/v3/template-functions).
249+
:::
250+
239251
```go
240252
func LocalRegistryNamespace() string
241253
```
@@ -267,6 +279,10 @@ For more information, see [Set Helm Values with KOTS](/vendor/helm-optional-valu
267279

268280
## LocalImageName
269281

282+
:::note
283+
The LocalImageName template function is not supported for installations with Embedded Cluster v3. See [Template Functions for Embedded Cluster (Beta)](/embedded-cluster/v3/template-functions).
284+
:::
285+
270286
```go
271287
func LocalImageName(remoteImageName string) string
272288
```
@@ -346,6 +362,10 @@ spec:
346362
347363
## HasLocalRegistry
348364
365+
:::note
366+
The HasLocalRegistry template function is not supported for installations with Embedded Cluster v3. See [Template Functions for Embedded Cluster (Beta)](/embedded-cluster/v3/template-functions).
367+
:::
368+
349369
```go
350370
func HasLocalRegistry() bool
351371
```

0 commit comments

Comments
 (0)