Skip to content

feat(ec): new PrivateCACert template function behavior #3278

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
May 29, 2025
Merged

feat(ec): new PrivateCACert template function behavior #3278

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
fc5ecdd
feat(ec): new PrivateCACert template function behavior
emosbaugh May 29, 2025
b736ef3
Explain how we find the ca trust store on the host
emosbaugh May 29, 2025
4f62e27
docs edits
paigecalvert May 29, 2025
626d6ae
Update template-functions-static-context.md
paigecalvert May 29, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions docs/reference/template-functions-static-context.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,12 +16,12 @@ This topic provides a list of the KOTS template functions in the Static context.
func PrivateCACert() string
```

PrivateCACert returns the name of a ConfigMap that contains private CA certificates provided by the end user. For Embedded Cluster installations, these certificates are provided with the `--private-ca` flag for the `install` command. For KOTS installations, the user provides the ConfigMap using the `--private-ca-configmap` flag for the `install` command.
For KOTS installations, PrivateCACert returns the name of a ConfigMap that contains CA certificates provided by the end user with the `--private-ca-configmap` flag for the install command. For Embedded Cluster installations, the ConfigMap returned by PrivateCACert contains the CA trust store from the host. Embedded Cluster determines the CA trust store by first checking for the SSL_CERT_FILE environment variable. If SSL_CERT_FILE is not set, Embedded Cluster then searches common certificate paths and uses the first valid certificate file found.

You can use this template function to mount the specified ConfigMap so your containers can access the internet through enterprise proxies that issue their own TLS certificates in order to inspect traffic.

:::note
This function will return the name of the ConfigMap even if the ConfigMap has no entries. If no ConfigMap exists, this function returns the empty string.
This function returns the name of the ConfigMap even if the ConfigMap has no entries. If no ConfigMap exists, this function returns the empty string.
:::

## Cluster Information Functions
Expand Down Expand Up @@ -630,4 +630,4 @@ This can be useful when dealing with user-uploaded files that may include null b

```yaml
repl{{ ConfigOptionData "my_file_upload" | YamlEscape }}
```
```