Repository navigation
Expand file tree
/
Copy pathmkdocs.yml
More file actions
250 lines (235 loc) · 9.48 KB
/
Copy pathmkdocs.yml
File metadata and controls
250 lines (235 loc) · 9.48 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
# Copyright (c) 2016-2017 Martin Donath <martin.donath@squidfunk.com>
# Copyright (c) 2018 OpenFaaS Author(s)
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to
# deal in the Software without restriction, including without limitation the
# rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
# sell copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
# The above copyright notice and this permission notice shall be included in
# all copies or substantial portions of the Software.
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
# IN THE SOFTWARE.
# Project information
site_name: OpenFaaS
site_description: OpenFaaS - Serverless Functions Made Simple
site_author: OpenFaaS Authors
site_url: https://docs.openfaas.com/
# Repository
repo_name: openfaas/faas
repo_url: https://github.com/openfaas/faas
edit_uri: ""
# edit_uri: edit/docs-revamp/docs/
# edit_uri: blob/docs-revamp/docs/
# remote_name: origin
# remote_branch: gh-pages
# Theme and overrides, i.e. language partial
theme:
name: material
icon:
logo: material/library
repo: fontawesome/brands/git-alt
# Don't include MkDocs' JavaScript
include_search_page: false
search_index_only: true
# Default values, taken from mkdocs_theme.yml
language: en
feature:
tabs: false
features:
- content.code.copy
palette:
primary: blue
accent: indigo
favicon: images/favicon.ico
logo: images/logo.svg
# Copyright
copyright: "Copyright © 2024 OpenFaaS Author(s)"
# Options
extra:
analytics:
provider: google
property: G-VN3JWY5DTN
anonymize_ip: true
search:
languages: "en"
social:
- icon: fontawesome/solid/earth-europe
link: https://www.openfaas.com/
- icon: fontawesome/brands/github-alt
link: https://github.com/openfaas
- icon: fontawesome/brands/twitter
link: https://twitter.com/openfaas
extra_css:
- stylesheets/extra.css
# Extensions
markdown_extensions:
- markdown.extensions.admonition
- markdown.extensions.codehilite:
guess_lang: false
- markdown.extensions.def_list
- markdown.extensions.footnotes
- markdown.extensions.meta
- markdown.extensions.toc:
permalink: true
- pymdownx.arithmatex
- pymdownx.betterem:
smart_enable: all
- pymdownx.caret
- pymdownx.critic
- pymdownx.details
- pymdownx.emoji:
emoji_generator: !!python/name:pymdownx.emoji.to_svg
- pymdownx.inlinehilite
- pymdownx.magiclink
- pymdownx.mark
- pymdownx.smartsymbols
- pymdownx.superfences
- pymdownx.tabbed:
alternate_style: true
- pymdownx.tasklist:
custom_checkbox: true
- pymdownx.tilde
# Page tree
nav:
- Overview:
- Introduction: index.md
- Community: community.md
- Getting Started:
- Deployment overview: deployment.md
- OpenFaaS CE: ./deployment/kubernetes.md
- OpenFaaS Pro: ./deployment/pro.md
- OpenFaaS Edge: ./deployment/edge.md
- OpenShift: ./deployment/openshift.md
- Troubleshooting: ./deployment/troubleshooting.md
- CLI:
- Installation: ./cli/install.md
- Create functions: ./cli/templates.md
- Build functions: ./cli/build.md
- Manage secrets: ./cli/secrets.md
- Logs: ./cli/logs.md
- Working with image tags: ./cli/tags.md
- Shell auto completion: ./cli/completion.md
- Languages:
- Overview: ./languages/overview.md
- Python:
- Overview: ./languages/python/index.md
- Examples:
- Deploy a function via API: ./languages/python/examples/openfaas-api.md
- Working with S3 objects: ./languages/python/examples/s3-boto3.md
- OpenAI Chat API: ./languages/python/examples/openai.md
- Publish to Kafka: ./languages/python/examples/kafka.md
- Web testing with Playwright: ./languages/python/examples/playwright.md
- Unit testing with pytest: ./languages/python/examples/testing.md
- OpenTelemetry zero-code instrumentation: ./languages/python/examples/opentelemetry.md
- AWS IAM Roles (IRSA): ./languages/python/examples/ecr-irsa.md
- Stream Server-Sent Events (SSE): ./languages/python/examples/sse.md
- Readiness checks for slow start-up: ./languages/python/examples/readiness.md
- Node: ./languages/node.md
- Go: ./languages/go.md
- C#: ./languages/csharp.md
- PHP: ./languages/php.md
- Dockerfile: ./languages/dockerfile.md
- Custom: ./languages/custom.md
- OpenFaaS Pro:
- Overview: ./openfaas-pro/introduction.md
- Scale to Zero: ./openfaas-pro/scale-to-zero.md
- Dashboard: ./openfaas-pro/dashboard.md
- Retries: ./openfaas-pro/retries.md
- IAM & Policy:
- Overview: ./openfaas-pro/iam/overview.md
- IAM Example: ./openfaas-pro/iam/example-auth0.md
- Function Authentication: ./openfaas-pro/iam/function-authentication.md
- GitHub Actions Federation: ./openfaas-pro/iam/github-actions-federation.md
- GitLab Federation: ./openfaas-pro/iam/gitlab-federation.md
- Bitbucket Federation: ./openfaas-pro/iam/bitbucket-federation.md
- Auditing Events: ./openfaas-pro/iam/auditing.md
- Troubleshooting: ./openfaas-pro/iam/troubleshooting.md
- Single Sign-On:
- Overview: ./openfaas-pro/sso/overview.md
- Google: ./openfaas-pro/sso/google.md
- Keycloak: ./openfaas-pro/sso/keycloak.md
- Microsoft Entra: ./openfaas-pro/sso/microsoft-entra.md
- Okta: ./openfaas-pro/sso/okta.md
- SSO with the CLI: ./openfaas-pro/sso/cli.md
- Function CRD: ./openfaas-pro/function-crd.md
- Queue Worker: ./openfaas-pro/jetstream.md
- Kafka events: ./openfaas-pro/kafka-events.md
- Postgres events: ./openfaas-pro/postgres-events.md
- AWS SQS events: ./openfaas-pro/sqs-events.md
- AWS SNS events: ./openfaas-pro/sns-events.md
- RabbitMQ events: ./openfaas-pro/rabbitmq-events.md
- Google Cloud PubSub events: ./openfaas-pro/pubsub-events.md
# - Federated Gateway: ./openfaas-pro/federated-gateway.md
- Air Gap: ./openfaas-pro/airgap.md
- Function Builder API: ./openfaas-pro/builder.md
- Billing metrics: ./openfaas-pro/billing-metrics.md
- Grafana dashboards: ./openfaas-pro/grafana-dashboards.md
- OpenFaaS Edge:
- Overview: ./edge/overview.md
- Manage services: ./edge/services.md
- Configure TLS: ./edge/tls.md
- Enable the dashboard: ./edge/dashboard.md
- Custom DNS: ./edge/custom-dns.md
- Scale to Zero: ./edge/scale-to-zero.md
- Kafka connector: ./edge/kafka-deployment.md
- Function Builder: ./edge/builder.md
- GPU for services: ./edge/gpus.md
- gVisor: ./edge/gvisor.md
- OpenTelemetry: ./edge/open-telemetry.md
- Air Gap: ./edge/airgap.md
- Preloading functions: ./edge/preloading.md
- Reference:
- OpenFaaS YAML: ./reference/yaml.md
- REST API: ./reference/rest-api.md
- TLS for OpenFaaS: ./reference/tls-openfaas.md
- TLS for Functions: ./reference/tls-functions.md
- Async: ./reference/async.md
- Private Registries: ./reference/private-registries.md
- Secrets: ./reference/secrets.md
- Triggers: ./reference/triggers.md
- Workloads: ./reference/workloads.md
- Cron: ./reference/cron.md
- CI/CD:
- Intro: ./reference/cicd/intro.md
- GitHub Actions: ./reference/cicd/github-actions.md
- Function Builder API: ./openfaas-pro/builder.md
- GitLab: ./reference/cicd/gitlab.md
- Bitbucket Pipelines: ./reference/cicd/bitbucket.md
- Jenkins: ./reference/cicd/jenkins.md
- Namespaces: ./reference/namespaces.md
- Authentication: ./reference/authentication.md
- OAuth login for functions: ./reference/function-oauth.md
- CORS: ./reference/cors.md
- Profiles: ./reference/profiles.md
- Design & Architecture:
- Invocations: ./architecture/invocations.md
- Autoscaling: ./architecture/autoscaling.md
- Gateway: ./architecture/gateway.md
- Watchdog: ./architecture/watchdog.md
- Metrics: ./architecture/metrics.md
- Stack: ./architecture/stack.md
- Production: ./architecture/production.md
- Performance: ./architecture/performance.md
- FaaS Provider: ./architecture/faas-provider.md
- Logs Provider: ./architecture/logs-provider.md
- Training:
- Overview: ./tutorials/training.md
- Tutorials:
- Extended timeouts: ./tutorials/expanded-timeouts.md
- CLI with Node.js: ./tutorials/CLI-with-node.md
- First Python Function: ./tutorials/first-python-function.md
- Local Ingress with KinD: ./tutorials/local-kind-ingress.md
- Local Registry with KinD: ./tutorials/local-kind-registry.md
- Featured: ./tutorials/featured.md
- Metrics retention: ./tutorials/long-term-metrics-retention.md
- Contributing:
- Get Started: ./contributing/get-started.md
- Code Repositories: ./contributing/code-repositories.md
- Signet:
- Overview: ./signet/overview.md