forked from knative/docs
-
Notifications
You must be signed in to change notification settings - Fork 0
/
mkdocs.yml
360 lines (353 loc) · 19.4 KB
/
mkdocs.yml
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
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
site_name: Knative
site_url: https://knative.dev/docs
site_description: Knative Documentation
extra_css:
- stylesheets/extra.css
repo_url: https://github.com/knative/docs
edit_uri: edit/main/docs
nav:
- Home: index.md
- Getting Started:
- Before you begin: getting-started/README.md
- Knative Quickstart: getting-started/install-knative-quickstart.md
- Serverless:
- First Knative Service: getting-started/first-service.md
- Scaling to Zero: getting-started/first-autoscale.md
- Traffic Splitting: getting-started/first-traffic-split.md
- Event-Driven Applications:
- Introducing Knative Eventing: getting-started/getting-started-eventing.md
- Sources, Brokers, Triggers, Sinks: getting-started/first-broker.md
- Introducing the CloudEvents Player: getting-started/first-source.md
- Creating your first Trigger: getting-started/first-trigger.md
- What's Next?: getting-started/next-steps.md
# Administration guide
- Administration guide:
- Overview: admin/README.md
- Installing Knative:
- Overview: admin/install/README.md
# Serving Installation
- Install Knative Serving:
- Install Serving with YAML: admin/install/serving/install-serving-with-yaml.md
- Knative Serving installation files: admin/install/serving/serving-installation-files.md
# Eventing Installation
- Install Knative Eventing:
- Install Eventing with YAML: admin/install/eventing/install-eventing-with-yaml.md
- Knative Eventing installation files: admin/install/eventing/eventing-installation-files.md
# Operator Installation
- Knative Operator:
- Installing with the Operator: admin/install/knative-with-operators.md
- Configuring Knative Eventing CRDs: admin/install/operator/configuring-eventing-cr.md
- Configuring Knative Serving CRDs: admin/install/operator/configuring-serving-cr.md
# Istio Installation
- Installing Istio for Knative: admin/install/installing-istio.md
# Vendor docs
- Using a Knative-based Offering: admin/install/knative-offerings.md
- Checking your Knative version: check-install-version.md
- Upgrading your installation:
- Overview: admin/upgrade/README.md
- Upgrading with the Knative Operator: admin/upgrade/upgrade-installation-with-operator.md
- Upgrading with kubectl: admin/upgrade/upgrade-installation.md
- Logging: admin/collecting-logs/README.md
# Administrator metrics
- Metrics:
- About metrics: admin/collecting-metrics/README.md
- Knative Eventing metrics: admin/collecting-metrics/eventing-metrics/metrics.md
- Knative Serving metrics: admin/collecting-metrics/serving-metrics/metrics.md
- Uninstalling Knative: admin/install/uninstall.md
# Serving config
- Knative Serving configuration:
- Configure Deployment resources: admin/serving/deployment.md
# Eventing config
- Knative Eventing configuration:
- Configure Broker defaults: admin/eventing/broker-configuration.md
- Configure Kafka Channel defaults: admin/eventing/kafka-channel-configuration.md
# Developer guide
- Developer guide:
- Overview: developer/README.md
- Knative Serving:
- Services:
- About Knative Services: developer/serving/services/README.md
- Creating a Service: developer/serving/services/creating-services.md
- Configuring private Services: developer/serving/services/private-services.md
- Configuring custom domains: developer/serving/services/custom-domains.md
- Configure resource requests and limits: developer/serving/services/configure-requests-limits-services.md
- Troubleshooting:
- Debugging application issues: developer/serving/troubleshooting/debugging-application-issues.md
- Knative Eventing:
- Event sources:
- ContainerSource:
- Creating a ContainerSource object: developer/eventing/sources/containersource/README.md
- ContainerSource Reference: developer/eventing/sources/containersource/reference.md
- Event delivery: developer/eventing/event-delivery.md
- Event sinks:
- About sinks: developer/eventing/sinks/README.md
- KafkaSink: developer/eventing/sinks/kafka-sink.md
# Developer concepts
- Concepts:
- Duck typing: developer/concepts/duck-typing.md
# Serving
- Knative Serving:
- Overview: serving/README.md
- Developer Topics:
- Deploying from private registries: serving/deploying-from-private-registry.md
- Tag resolution: serving/tag-resolution.md
- Gradually rolling out latest Revisions: serving/rolling-out-latest-revision.md
- Creating and using Subroutes: serving/using-subroutes.md
- Load balancing:
- Overview: serving/load-balancing/README.md
- Configuring target burst capacity: serving/load-balancing/target-burst-capacity.md
- Autoscaling:
- Overview: serving/autoscaling/README.md
- Supported autoscaler types: serving/autoscaling/autoscaler-types.md
- Metrics: serving/autoscaling/autoscaling-metrics.md
- Targets: serving/autoscaling/autoscaling-targets.md
- Configuring scale to zero: serving/autoscaling/scale-to-zero.md
- Configuring concurrency: serving/autoscaling/concurrency.md
- Configuring the requests per second (RPS) target: serving/autoscaling/rps-target.md
- Configuring scale bounds: serving/autoscaling/scale-bounds.md
- Additional autoscaling configuration for Knative Pod Autoscaler: serving/autoscaling/kpa-specific.md
- Autoscale Sample App - Go: serving/autoscaling/autoscale-go/README.md
# Admin topics - serving
- Administrator Topics:
- Kubernetes services: serving/knative-kubernetes-services.md
- Accessing request traces: serving/accessing-traces.md
- Enabling requests to Knative services when additional authorization policies are enabled: serving/istio-authorization.md
- Exclude namespaces from the Knative webhook: serving/webhook-customizations.md
- Configuring high-availability components: serving/config-ha.md
- Installing cert-manager: serving/installing-cert-manager.md
- Configuring HTTPS connections: serving/using-a-tls-cert.md
- Enabling auto-TLS certs: serving/using-auto-tls.md
- Feature/Extension Flags: serving/feature-flags.md
- Configuring the ingress gateway: serving/setting-up-custom-ingress-gateway.md
- Setting up a custom domain: serving/using-a-custom-domain.md
- Code samples:
- Overview: serving/samples/README.md
- Routing and managing traffic: serving/samples/blue-green-deployment.md
- Cloud Events apps:
- Overview: serving/samples/cloudevents/README.md
- .NET: serving/samples/cloudevents/cloudevents-dotnet/README.md
- Go: serving/samples/cloudevents/cloudevents-go/README.md
- Node.js: serving/samples/cloudevents/cloudevents-nodejs/README.md
- Rust: serving/samples/cloudevents/cloudevents-rust/README.md
- Java and Spring: serving/samples/cloudevents/cloudevents-spring/README.md
- Java and Vert.x: serving/samples/cloudevents/cloudevents-vertx/README.md
- GitHub Webhook - Go: serving/samples/gitwebhook-go/README.md
- gRPC Server - Go: serving/samples/grpc-ping-go/README.md
- Hello world apps:
- Overview: serving/samples/hello-world/README.md
- .NET: serving/samples/hello-world/helloworld-csharp/README.md
- Go: serving/samples/hello-world/helloworld-go/README.md
- Java (Spark): serving/samples/hello-world/helloworld-java-spark/README.md
- Hello World - Spring Boot Java: serving/samples/hello-world/helloworld-java-spring/README.md
- Kotlin: serving/samples/hello-world/helloworld-kotlin/README.md
- Node.js: serving/samples/hello-world/helloworld-nodejs/README.md
- PHP: serving/samples/hello-world/helloworld-php/README.md
- Python: serving/samples/hello-world/helloworld-python/README.md
- Ruby: serving/samples/hello-world/helloworld-ruby/README.md
- Scala: serving/samples/hello-world/helloworld-scala/README.md
- Shell: serving/samples/hello-world/helloworld-shell/README.md
- Routing services - Go: serving/samples/knative-routing-go/README.md
- multi-container samples: serving/samples/multi-container/README.md
- RESTful service - Go: serving/samples/rest-api-go/README.md
- Secrets - Go: serving/samples/secrets-go/README.md
- Tag Header Based Routing: serving/samples/tag-header-based-routing/README.md
- Traffic splitting: serving/samples/traffic-splitting/README.md
# Eventing
- Knative Eventing:
- Overview: eventing/README.md
- Getting started: eventing/getting-started.md
- Event sources:
- Overview: eventing/sources/README.md
- API server source:
- Overview: eventing/sources/apiserversource/README.md
- Getting started: eventing/sources/apiserversource/getting-started/README.md
- PingSource: eventing/sources/ping-source/README.md
- SinkBinding:
- Overview: eventing/sources/sinkbinding/README.md
- Creating a SinkBinding object: eventing/sources/sinkbinding/getting-started.md
- SinkBinding reference: eventing/sources/sinkbinding/reference.md
- Camel source: eventing/sources/apache-camel-source/README.md
- Kafka source: eventing/sources/kafka-source/README.md
- Creating an event source:
- Overview: eventing/sources/creating-event-sources/README.md
- Writing an event source using Javascript: eventing/sources/creating-event-sources/writing-event-source-easy-way/README.md
- Using the sample event source:
- Overview: eventing/sources/creating-event-sources/writing-event-source/README.md
- Design of an Event Source: eventing/sources/creating-event-sources/writing-event-source/01-theory.md
- Lifecycle and Types: eventing/sources/creating-event-sources/writing-event-source/02-lifecycle-and-types.md
- Controller Implemetation: eventing/sources/creating-event-sources/writing-event-source/03-controller.md
- Reconciler Implementation: eventing/sources/creating-event-sources/writing-event-source/04-reconciler.md
- Receive Adapter Implementation: eventing/sources/creating-event-sources/writing-event-source/05-receive-adapter.md
- Publishing to your cluster: eventing/sources/creating-event-sources/writing-event-source/06-yaml.md
- Moving to knative-sandbox: eventing/sources/creating-event-sources/writing-event-source/07-knative-sandbox.md
- Event registry: eventing/event-registry.md
- Flows:
- Overview: eventing/flows/README.md
- Parallel: eventing/flows/parallel.md
- Sequence:
- Overview: eventing/flows/sequence/README.md
- Displaying sequence output: eventing/flows/sequence/sequence-reply-to-event-display/README.md
- Using Sequences in series: eventing/flows/sequence/sequence-reply-to-sequence/README.md
- Create additional events: eventing/flows/sequence/sequence-terminal/README.md
- Using with Broker and Trigger: eventing/flows/sequence/sequence-with-broker-trigger/README.md
- Channels:
- Overview: eventing/channels/README.md
- Channel types and defaults: eventing/channels/channel-types-defaults.md
- Creating a channel using cluster or namespace defaults: eventing/channels/create-default-channel.md
- Available Channels: eventing/channels/channels-crds.md
- Subscriptions: eventing/channels/subscriptions.md
- Sugar Controller: eventing/sugar/README.md
- Brokers:
- Overview: eventing/broker/README.md
- Creating a broker: eventing/broker/create-mtbroker.md
- Triggers: eventing/broker/triggers/README.md
- Broker configuration example: eventing/broker/example-mtbroker.md
- Apache Kafka Broker:
- Overview: eventing/broker/kafka-broker/README.md
- Debugging: eventing/debugging/README.md
- Accessing CloudEvent traces: eventing/accessing-traces.md
- Experimental Features: eventing/experimental-features.md
- Code samples:
- Overview: eventing/samples/README.md
- Container source: eventing/sources/container-source/README.md
- Hello World:
- Overview: eventing/samples/helloworld/README.md
- GO: eventing/samples/helloworld/helloworld-go/README.md
- Python: eventing/samples/helloworld/helloworld-python/README.md
- Apache Kafka:
- Overview: eventing/samples/kafka/README.md
- Binding Example: eventing/samples/kafka/binding/README.md
- Channel Example: eventing/samples/kafka/channel/README.md
- Parallel:
- Overview: eventing/samples/parallel/README.md
- Multiple Cases: eventing/samples/parallel/multiple-branches/README.md
- Mutual Exclusivity: eventing/samples/parallel/mutual-exclusivity/README.md
- CloudAuditLogsSource: eventing/sources/cloud-audit-logs-source/README.md
- CloudPubSubSource: eventing/sources/cloud-pubsub-source/README.md
- CloudSchedulerSource: eventing/sources/cloud-scheduler-source/README.md
- CloudStorageSource: eventing/sources/cloud-storage-source/README.md
- GitHub source: eventing/sources/github-source/README.md
- GitLab source: eventing/sources/gitlab-source/README.md
- IoT core: eventing/samples/iot-core/README.md
# Reference docs
- Reference:
- Serving: reference/api/serving-api.md
- Eventing: reference/api/eventing-api.md
# Client
- Client:
- Overview: client/README.md
- Installing kn: client/install-kn.md
- Customizing kn: client/configure-kn.md
- kn plugins: client/kn-plugins.md
- "Join the Community ➠": /community/
- "Read the Blog ➠": /blog/
theme:
name: material
logo: images/logo/rgb/knative-logo-rgb.png
favicon: images/knative-sm.png
custom_dir: overrides
features:
- navigation.tabs
- navigation.tracking
- navigation.tabs.sticky
- navigation.indexes
- navigation.top
markdown_extensions:
# - mdx_include:
# base_path: docs
- pymdownx.emoji:
emoji_index: !!python/name:materialx.emoji.twemoji
emoji_generator: !!python/name:materialx.emoji.to_svg
- attr_list
- meta
- pymdownx.superfences
- pymdownx.tabbed
- pymdownx.details
- pymdownx.snippets:
base_path: docs/snippets
- pymdownx.keys
- pymdownx.caret
- pymdownx.mark
- pymdownx.tilde
- pymdownx.escapeall
- pymdownx.tasklist:
custom_checkbox: true
- admonition
- toc:
permalink: true
- def_list
plugins:
- search
- macros:
module_name: hack/macros
include_dir: docs/snippets
- exclude:
glob:
# Exclude files that contain hugo specific shortcodes
# (either the include shortcode or not-converted-yet tabs).
- snippets/*
- smoketest.md
- "*/_index.md" # pretty much all shortcodes
- awesome-pages:
filename: ".index"
collapse_single_pages: true
strict: false
# Redirects
- redirects:
redirect_maps:
'serving/autoscaling/autoscaling-concepts.md': 'serving/autoscaling/autoscaler-types.md'
'eventing/sink/kafka-sink.md': 'developer/eventing/sinks/kafka-sink.md'
'eventing/sink/README.md': 'developer/eventing/sinks/README.md'
'eventing/broker/broker-event-delivery.md': 'developer/eventing/event-delivery.md'
'eventing/event-delivery.md': 'developer/eventing/event-delivery.md'
'eventing/broker/kafka-broker/kafka-configmap.md': 'admin/eventing/kafka-channel-configuration.md'
'eventing/broker/configmaps/README.md': 'admin/eventing/broker-configuration.md'
'help/README.md': 'docs/help/contributor/README.md'
'serving/metrics.md': 'admin/collecting-metrics/serving-metrics/metrics.md'
'eventing/metrics.md': 'admin/collecting-metrics/eventing-metrics/metrics.md'
'help/README.md': 'docs/help/contributor/README.md'
'eventing/samples/sinkbinding/README.md': 'eventing/sources/sinkbinding/README.md'
'admin/install/install-serving-with-yaml.md': 'admin/install/serving/install-serving-with-yaml.md'
'admin/install/install-eventing-with-yaml.md': 'admin/install/eventing/install-eventing-with-yaml.md'
'serving/services/deployment.md': 'admin/serving/deployment.md'
'serving/debugging-application-issues.md': 'developer/serving/troubleshooting/debugging-application-issues.md'
'serving/creating-domain-mappings.md': 'developer/serving/services/custom-domains.md'
'install/collecting-logs/index.md': 'admin/collecting-logs/README.md'
'install/README.md': 'admin/install/README.md'
'install/collecting-metrics/index.md': 'admin/collecting-metrics/README.md'
'install/install-eventing-with-yaml.md': 'admin/install/eventing/install-eventing-with-yaml.md'
# This doesn't exist anymore, we should probably replace it
'install/install-extensions.md': 'admin/install/README.md'
'install/install-serving-with-yaml.md': 'admin/install/serving/install-serving-with-yaml.md'
'install/installation-files.md': 'admin/install/README.md'
'install/installing-istio.md': 'admin/install/installing-istio.md'
'install/knative-offerings.md': 'admin/install/knative-offerings.md'
'install/knative-with-operators.md': 'admin/install/knative-with-operators.md'
'install/operator/configuring-eventing-cr.md': 'admin/install/operator/configuring-eventing-cr.md'
'install/operator/configuring-serving-cr.md': 'admin/install/operator/configuring-serving-cr.md'
'install/prerequisites.md': 'admin/install/README.md'
'uninstall.md': 'admin/install/uninstall.md'
'upgrade/index.md': 'admin/upgrade/README.md'
'upgrade/upgrade-installation-with-operator.md': 'admin/upgrade/upgrade-installation-with-operator.md'
'upgrade/upgrade-installation.md': 'admin/upgrade/upgrade-installation.md'
'install/check-install-version.md': 'check-install-version.md'
'serving/services/private-services.md': 'developer/serving/services/private-services.md'
'serving/services/creating-services.md': 'developer/serving/services/creating-services.md'
'serving/services/README.md': 'developer/serving/services/README.md'
copyright: "Copyright © 2021 The Knative Authors"
extra:
branch: v0.23.0 # Branch to use for examples
social:
- icon: fontawesome/brands/twitter
link: https://twitter.com/KnativeProject
- icon: fontawesome/brands/github
link: https://github.com/knative/community
name: Knative Community on Github
- icon: fontawesome/brands/slack
link: https://slack.knative.dev
name: Slack
# TODO: Replace with https://github.com/mkdocs/mkdocs/pull/2267 once mkdocs 1.2 is out.
version_warning: !!python/object/apply:os.getenv ["VERSION_WARNING"]
knative_version: !!python/object/apply:os.getenv ["KNATIVE_VERSION"]
version:
provider: mike