Skip to content

Commit a664e62

Browse files
committed
Update limit for function name limit
Signed-off-by: Alex Ellis (OpenFaaS Ltd) <[email protected]>
1 parent 8002c68 commit a664e62

File tree

4 files changed

+12
-10
lines changed

4 files changed

+12
-10
lines changed

docs/deployment/troubleshooting.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -94,9 +94,17 @@ Common issues:
9494
* You haven't created a secret which is required for your function to start. Check your function request or stack.yml, and create any missing secrets.
9595
* Your function is crashing due to an error in your code, check the logs.
9696

97-
### I think my function's name is too long
97+
### Is my function's name too long?
9898

99-
When using Kubernetes, a function's name should be no longer than 45 characters if it also mounts a secret. This is due to how the projected volume for the Pod's secrets is named.
99+
When using Kubernetes along with the Function CRD, a function's name can be no longer than 63 characters. This is due to a limitation on the length of label selectors within Kubernetes.
100+
101+
If you need longer names for the sake of organisation, then consider [using namespaces](/reference/namespaces) to partition your functions.
102+
103+
For example:
104+
105+
`project-skunkworks-long-function-name` could be shortened to `long-function-name`, and then placed in the `project-skunkworks` namespace, effectively going longer than the 63 character limit for organisation.
106+
107+
OpenFaaS namespaces are available in faasd and OpenFaaS for Enterprises.
100108

101109
### My function is timing out
102110

docs/openfaas-pro/billing-metrics.md

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,9 +21,6 @@ To start receiving events with detailed usage metrics you need to enable meterin
2121
You will need to create an `endpointSecret` which will be shared with the HTTP receiver, and used to sign the webhook payload.
2222

2323
```bash
24-
# If openssl is not available on your system, use the following:
25-
head -c 32 /dev/urandom | base64 | cut -d "-" -f1 > billing-endpoint-secret.txt
26-
2724
# openssl is preferred to generate a random secret:
2825
openssl rand -base64 32 > billing-endpoint-secret.txt
2926

docs/openfaas-pro/iam/auditing.md

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,9 +23,6 @@ To start receiving auditing events you need to enable auditing and configure a w
2323
You will need to create an `endpointSecret` which will be shared with the HTTP receiver, and used to sign the webhook payload.
2424

2525
```bash
26-
# If openssl is not available on your system, use the following:
27-
head -c 32 /dev/urandom | base64 | cut -d "-" -f1 > ./event-webhook-secret.txt
28-
2926
# openssl is preferred to generate a random secret:
3027
openssl rand -base64 32 > ./event-webhook-secret.txt
3128

docs/reference/namespaces.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -97,15 +97,15 @@ Deploy the stack.yml and invoke the function:
9797
```sh
9898
faas-cli deploy
9999

100-
head -c 16 /dev/urandom | faas-cli invoke --namespace dev stronghash
100+
openssl rand -base64 32 | faas-cli invoke --namespace dev stronghash
101101
```
102102

103103
Override the namespace configured in the stack.yml when deploying the function and test:
104104

105105
```sh
106106
faas-cli deploy --namespace staging-fn
107107

108-
head -c 16 /dev/urandom | faas-cli invoke --namespace staging-fn stronghash
108+
openssl rand -base64 32 | faas-cli invoke --namespace staging-fn stronghash
109109
```
110110

111111
## Controlling network access

0 commit comments

Comments
 (0)