From f184d13c56ed1dac9fa7d5255ca5a50eae9466e2 Mon Sep 17 00:00:00 2001 From: Gaurav Gahlot Date: Fri, 9 Jul 2021 10:23:49 +0530 Subject: [PATCH] Restructuring the docs (#274) Restructuring the overall layout for better experience. More updates to follow in each section. --- docs/config.toml | 2 +- docs/content/en/docs/architecture/_index.md | 55 ++++++ .../assets/builder-pod.png | Bin .../assets/buildermanager.png | Bin .../assets/controller.png | Bin .../core => architecture}/assets/executor.png | Bin .../assets/function-pod.png | Bin .../assets/kubewatcher.png | Bin .../assets/logger.png | Bin .../assets/mqtrigger.png | Bin .../assets/newdeploy.png | Bin .../assets/poolmanager.png | Bin .../core => architecture}/assets/router.png | Bin .../assets/storagesvc.png | Bin .../assets/timer.png | Bin .../core => architecture}/builder-pod.md | 0 .../core => architecture}/buildermgr.md | 0 .../core => architecture}/controller.md | 0 .../core => architecture}/executor.md | 2 +- .../core => architecture}/function-pod.md | 0 .../optional => architecture}/kubewatcher.md | 2 +- .../optional => architecture}/logger.md | 2 +- .../message-queue-trigger.md | 2 +- .../core => architecture}/router.md | 0 .../core => architecture}/storagesvc.md | 0 .../optional => architecture}/timer.md | 2 +- docs/content/en/docs/concepts/_index.md | 6 +- .../en/docs/concepts/components/_index.md | 5 - .../docs/concepts/components/core/_index.md | 6 - .../concepts/components/optional/_index.md | 6 - .../content/en/docs/contributing/_index.en.md | 3 +- .../content/en/docs/installation/_index.en.md | 6 +- .../en/docs/installation/advanced-setup.en.md | 2 +- .../compatibility.md} | 2 +- .../en/docs/installation/docker-desktop.md | 4 +- .../en/docs/installation/env_vars.en.md | 2 +- .../docs/installation/on-premise-install.md | 2 +- .../content/en/docs/installation/openshift.md | 2 +- .../_index.md => installation/upgrade.md} | 2 +- docs/content/en/docs/releases/1.4.1.md | 2 +- docs/content/en/docs/releases/_index.en.md | 2 +- .../en/docs/trouble-shooting/_index.en.md | 2 +- docs/content/en/docs/usage/_index.en.md | 2 +- .../en/docs/usage/function/_index.en.md | 6 + .../access-secret-cfgmap-in-function.en.md | 0 .../{ => function}/accessing-url-params.md | 0 .../{ => function}/canary-deployments.md | 0 .../enabling-istio-on-fission.md | 2 +- .../usage/{ => function}/environments.en.md | 0 .../docs/usage/{ => function}/executor.en.md | 2 +- .../docs/usage/{ => function}/functions.en.md | 2 +- .../docs/usage/{ => function}/package.en.md | 0 .../usage/{ => function}/private-registry.md | 0 .../{ => function}/url-as-archive-source.md | 0 docs/content/en/docs/usage/ingress/_index.md | 3 +- .../en/docs/{ => usage}/languages/_index.md | 2 +- .../en/docs/{ => usage}/languages/go.md | 2 +- .../en/docs/{ => usage}/languages/java.md | 2 +- .../en/docs/{ => usage}/languages/nodejs.md | 2 +- .../en/docs/{ => usage}/languages/python.md | 4 +- .../docs/{ => usage}/observability/_index.md | 2 +- .../observability/assets/fission-linkerd.png | Bin .../observability/assets/linkerd-after.png | Bin .../observability/assets/linkerd-before.png | Bin .../assets/linkerd-dashboard.png | Bin .../observability/assets/linkerd-demo.mp4 | Bin .../observability/assets/linkerd-grafana.png | Bin .../assets/loki-grafana-dashboard.png | Bin .../assets/prometheus-grafana.png | Bin .../observability/assets/stack.png | Bin .../docs/{ => usage}/observability/linkerd.md | 0 .../en/docs/{ => usage}/observability/loki.md | 0 .../{ => usage}/observability/prometheus.md | 0 .../en/docs/{ => usage}/spec/_index.md | 8 +- .../docs/{ => usage}/spec/podspec/_index.md | 0 .../{ => usage}/spec/podspec/containers.md | 0 .../docs/{ => usage}/spec/podspec/envvar.md | 0 .../{ => usage}/spec/podspec/toleration.md | 0 .../docs/{ => usage}/spec/podspec/volume.md | 0 .../en/docs/{ => usage}/triggers/_index.md | 2 +- .../triggers/assets/message-queue-trigger.png | Bin .../triggers/assets/mqt-kind-keda.png | Bin .../docs/{ => usage}/triggers/http-trigger.md | 4 +- .../docs/{ => usage}/triggers/kubewatcher.md | 0 .../message-queue-trigger-kind-keda/_index.md | 0 .../aws-kinesis.md | 2 +- .../aws-sqs.md | 2 +- .../nats-streaming.md | 2 +- .../triggers/message-queue-trigger/_index.md | 0 .../assets/nats-example.png | Bin .../triggers/message-queue-trigger/kafka.md | 2 +- .../message-queue-trigger/nats-streaming.md | 0 .../en/docs/{ => usage}/triggers/timer.md | 0 docs/content/en/docs/workflows/_index.en.md | 159 ------------------ 94 files changed, 110 insertions(+), 223 deletions(-) create mode 100644 docs/content/en/docs/architecture/_index.md rename docs/content/en/docs/{concepts/components/core => architecture}/assets/builder-pod.png (100%) rename docs/content/en/docs/{concepts/components/core => architecture}/assets/buildermanager.png (100%) rename docs/content/en/docs/{concepts/components/core => architecture}/assets/controller.png (100%) rename docs/content/en/docs/{concepts/components/core => architecture}/assets/executor.png (100%) rename docs/content/en/docs/{concepts/components/core => architecture}/assets/function-pod.png (100%) rename docs/content/en/docs/{concepts/components/optional => architecture}/assets/kubewatcher.png (100%) rename docs/content/en/docs/{concepts/components/optional => architecture}/assets/logger.png (100%) rename docs/content/en/docs/{concepts/components/optional => architecture}/assets/mqtrigger.png (100%) rename docs/content/en/docs/{concepts/components/core => architecture}/assets/newdeploy.png (100%) rename docs/content/en/docs/{concepts/components/core => architecture}/assets/poolmanager.png (100%) rename docs/content/en/docs/{concepts/components/core => architecture}/assets/router.png (100%) rename docs/content/en/docs/{concepts/components/core => architecture}/assets/storagesvc.png (100%) rename docs/content/en/docs/{concepts/components/optional => architecture}/assets/timer.png (100%) rename docs/content/en/docs/{concepts/components/core => architecture}/builder-pod.md (100%) rename docs/content/en/docs/{concepts/components/core => architecture}/buildermgr.md (100%) rename docs/content/en/docs/{concepts/components/core => architecture}/controller.md (100%) rename docs/content/en/docs/{concepts/components/core => architecture}/executor.md (99%) rename docs/content/en/docs/{concepts/components/core => architecture}/function-pod.md (100%) rename docs/content/en/docs/{concepts/components/optional => architecture}/kubewatcher.md (98%) rename docs/content/en/docs/{concepts/components/optional => architecture}/logger.md (98%) rename docs/content/en/docs/{concepts/components/optional => architecture}/message-queue-trigger.md (98%) rename docs/content/en/docs/{concepts/components/core => architecture}/router.md (100%) rename docs/content/en/docs/{concepts/components/core => architecture}/storagesvc.md (100%) rename docs/content/en/docs/{concepts/components/optional => architecture}/timer.md (97%) delete mode 100644 docs/content/en/docs/concepts/components/_index.md delete mode 100644 docs/content/en/docs/concepts/components/core/_index.md delete mode 100644 docs/content/en/docs/concepts/components/optional/_index.md rename docs/content/en/docs/{compatibility/_index.md => installation/compatibility.md} (95%) rename docs/content/en/docs/{upgrade/_index.md => installation/upgrade.md} (99%) create mode 100644 docs/content/en/docs/usage/function/_index.en.md rename docs/content/en/docs/usage/{ => function}/access-secret-cfgmap-in-function.en.md (100%) rename docs/content/en/docs/usage/{ => function}/accessing-url-params.md (100%) rename docs/content/en/docs/usage/{ => function}/canary-deployments.md (100%) rename docs/content/en/docs/usage/{ => function}/enabling-istio-on-fission.md (97%) rename docs/content/en/docs/usage/{ => function}/environments.en.md (100%) rename docs/content/en/docs/usage/{ => function}/executor.en.md (98%) rename docs/content/en/docs/usage/{ => function}/functions.en.md (98%) rename docs/content/en/docs/usage/{ => function}/package.en.md (100%) rename docs/content/en/docs/usage/{ => function}/private-registry.md (100%) rename docs/content/en/docs/usage/{ => function}/url-as-archive-source.md (100%) rename docs/content/en/docs/{ => usage}/languages/_index.md (98%) rename docs/content/en/docs/{ => usage}/languages/go.md (99%) rename docs/content/en/docs/{ => usage}/languages/java.md (99%) rename docs/content/en/docs/{ => usage}/languages/nodejs.md (99%) rename docs/content/en/docs/{ => usage}/languages/python.md (97%) rename docs/content/en/docs/{ => usage}/observability/_index.md (89%) rename docs/content/en/docs/{ => usage}/observability/assets/fission-linkerd.png (100%) rename docs/content/en/docs/{ => usage}/observability/assets/linkerd-after.png (100%) rename docs/content/en/docs/{ => usage}/observability/assets/linkerd-before.png (100%) rename docs/content/en/docs/{ => usage}/observability/assets/linkerd-dashboard.png (100%) rename docs/content/en/docs/{ => usage}/observability/assets/linkerd-demo.mp4 (100%) rename docs/content/en/docs/{ => usage}/observability/assets/linkerd-grafana.png (100%) rename docs/content/en/docs/{ => usage}/observability/assets/loki-grafana-dashboard.png (100%) rename docs/content/en/docs/{ => usage}/observability/assets/prometheus-grafana.png (100%) rename docs/content/en/docs/{ => usage}/observability/assets/stack.png (100%) rename docs/content/en/docs/{ => usage}/observability/linkerd.md (100%) rename docs/content/en/docs/{ => usage}/observability/loki.md (100%) rename docs/content/en/docs/{ => usage}/observability/prometheus.md (100%) rename docs/content/en/docs/{ => usage}/spec/_index.md (98%) rename docs/content/en/docs/{ => usage}/spec/podspec/_index.md (100%) rename docs/content/en/docs/{ => usage}/spec/podspec/containers.md (100%) rename docs/content/en/docs/{ => usage}/spec/podspec/envvar.md (100%) rename docs/content/en/docs/{ => usage}/spec/podspec/toleration.md (100%) rename docs/content/en/docs/{ => usage}/spec/podspec/volume.md (100%) rename docs/content/en/docs/{ => usage}/triggers/_index.md (98%) rename docs/content/en/docs/{ => usage}/triggers/assets/message-queue-trigger.png (100%) rename docs/content/en/docs/{ => usage}/triggers/assets/mqt-kind-keda.png (100%) rename docs/content/en/docs/{ => usage}/triggers/http-trigger.md (93%) rename docs/content/en/docs/{ => usage}/triggers/kubewatcher.md (100%) rename docs/content/en/docs/{ => usage}/triggers/message-queue-trigger-kind-keda/_index.md (100%) rename docs/content/en/docs/{ => usage}/triggers/message-queue-trigger-kind-keda/aws-kinesis.md (98%) rename docs/content/en/docs/{ => usage}/triggers/message-queue-trigger-kind-keda/aws-sqs.md (98%) rename docs/content/en/docs/{ => usage}/triggers/message-queue-trigger-kind-keda/nats-streaming.md (98%) rename docs/content/en/docs/{ => usage}/triggers/message-queue-trigger/_index.md (100%) rename docs/content/en/docs/{ => usage}/triggers/message-queue-trigger/assets/nats-example.png (100%) rename docs/content/en/docs/{ => usage}/triggers/message-queue-trigger/kafka.md (98%) rename docs/content/en/docs/{ => usage}/triggers/message-queue-trigger/nats-streaming.md (100%) rename docs/content/en/docs/{ => usage}/triggers/timer.md (100%) delete mode 100644 docs/content/en/docs/workflows/_index.en.md diff --git a/docs/config.toml b/docs/config.toml index 5080a502..2d0deb82 100644 --- a/docs/config.toml +++ b/docs/config.toml @@ -98,7 +98,7 @@ release_version = "1.13.1" # User interface configuration [params.ui] # Enable to show the side bar menu in its compact state. -sidebar_menu_compact = false +sidebar_menu_compact = true # Set to true to disable breadcrumb navigation. breadcrumb_disable = false diff --git a/docs/content/en/docs/architecture/_index.md b/docs/content/en/docs/architecture/_index.md new file mode 100644 index 00000000..bc0ec85c --- /dev/null +++ b/docs/content/en/docs/architecture/_index.md @@ -0,0 +1,55 @@ +--- +title: "Architecture" +weight: 30 +no_list: true +description: > + Fission architecture in detail +--- + +Fission consists of multiple components that build up the architecture. +From a user's and contributor's perspective these components can be broadly grouped into core and optional components. + +The core components are the ones you should definitely know about while using fission. +The optional components, on the other hand, are good to know and can be learned as you go. + +## Core Components + +The core components include: + +### [Controller](controller.md) +Accept REST API requests and create Fission resources + +### [Executor](executor.md) +Component to spin up function pods + +### [Router](router.md) +Bridge between triggers and functions + +### [Function Pod](function-pod.md) +Place to load and execute the user function + +### [Builder Manager](buildermgr.md) +Compile the source code into a runnable function + +### [Builder Pod](builder-pod.md) +Place to load and execute the user function + +### [StorageSvc](storagesvc.md) +Home for source and deployment archives + + +## Optional Components + +The optional components include: + +### [Logger](logger.md) +Record and persist function logs + +### [KubeWatcher](kubewatcher.md) +Hawkeye to watch resource changes in Kubernetes cluster + +### [Message Queue Trigger](message-queue-trigger.md) +Subscribe topics and invoke functions + +### [Timer](timer.md) +Invoke functions periodically diff --git a/docs/content/en/docs/concepts/components/core/assets/builder-pod.png b/docs/content/en/docs/architecture/assets/builder-pod.png similarity index 100% rename from docs/content/en/docs/concepts/components/core/assets/builder-pod.png rename to docs/content/en/docs/architecture/assets/builder-pod.png diff --git a/docs/content/en/docs/concepts/components/core/assets/buildermanager.png b/docs/content/en/docs/architecture/assets/buildermanager.png similarity index 100% rename from docs/content/en/docs/concepts/components/core/assets/buildermanager.png rename to docs/content/en/docs/architecture/assets/buildermanager.png diff --git a/docs/content/en/docs/concepts/components/core/assets/controller.png b/docs/content/en/docs/architecture/assets/controller.png similarity index 100% rename from docs/content/en/docs/concepts/components/core/assets/controller.png rename to docs/content/en/docs/architecture/assets/controller.png diff --git a/docs/content/en/docs/concepts/components/core/assets/executor.png b/docs/content/en/docs/architecture/assets/executor.png similarity index 100% rename from docs/content/en/docs/concepts/components/core/assets/executor.png rename to docs/content/en/docs/architecture/assets/executor.png diff --git a/docs/content/en/docs/concepts/components/core/assets/function-pod.png b/docs/content/en/docs/architecture/assets/function-pod.png similarity index 100% rename from docs/content/en/docs/concepts/components/core/assets/function-pod.png rename to docs/content/en/docs/architecture/assets/function-pod.png diff --git a/docs/content/en/docs/concepts/components/optional/assets/kubewatcher.png b/docs/content/en/docs/architecture/assets/kubewatcher.png similarity index 100% rename from docs/content/en/docs/concepts/components/optional/assets/kubewatcher.png rename to docs/content/en/docs/architecture/assets/kubewatcher.png diff --git a/docs/content/en/docs/concepts/components/optional/assets/logger.png b/docs/content/en/docs/architecture/assets/logger.png similarity index 100% rename from docs/content/en/docs/concepts/components/optional/assets/logger.png rename to docs/content/en/docs/architecture/assets/logger.png diff --git a/docs/content/en/docs/concepts/components/optional/assets/mqtrigger.png b/docs/content/en/docs/architecture/assets/mqtrigger.png similarity index 100% rename from docs/content/en/docs/concepts/components/optional/assets/mqtrigger.png rename to docs/content/en/docs/architecture/assets/mqtrigger.png diff --git a/docs/content/en/docs/concepts/components/core/assets/newdeploy.png b/docs/content/en/docs/architecture/assets/newdeploy.png similarity index 100% rename from docs/content/en/docs/concepts/components/core/assets/newdeploy.png rename to docs/content/en/docs/architecture/assets/newdeploy.png diff --git a/docs/content/en/docs/concepts/components/core/assets/poolmanager.png b/docs/content/en/docs/architecture/assets/poolmanager.png similarity index 100% rename from docs/content/en/docs/concepts/components/core/assets/poolmanager.png rename to docs/content/en/docs/architecture/assets/poolmanager.png diff --git a/docs/content/en/docs/concepts/components/core/assets/router.png b/docs/content/en/docs/architecture/assets/router.png similarity index 100% rename from docs/content/en/docs/concepts/components/core/assets/router.png rename to docs/content/en/docs/architecture/assets/router.png diff --git a/docs/content/en/docs/concepts/components/core/assets/storagesvc.png b/docs/content/en/docs/architecture/assets/storagesvc.png similarity index 100% rename from docs/content/en/docs/concepts/components/core/assets/storagesvc.png rename to docs/content/en/docs/architecture/assets/storagesvc.png diff --git a/docs/content/en/docs/concepts/components/optional/assets/timer.png b/docs/content/en/docs/architecture/assets/timer.png similarity index 100% rename from docs/content/en/docs/concepts/components/optional/assets/timer.png rename to docs/content/en/docs/architecture/assets/timer.png diff --git a/docs/content/en/docs/concepts/components/core/builder-pod.md b/docs/content/en/docs/architecture/builder-pod.md similarity index 100% rename from docs/content/en/docs/concepts/components/core/builder-pod.md rename to docs/content/en/docs/architecture/builder-pod.md diff --git a/docs/content/en/docs/concepts/components/core/buildermgr.md b/docs/content/en/docs/architecture/buildermgr.md similarity index 100% rename from docs/content/en/docs/concepts/components/core/buildermgr.md rename to docs/content/en/docs/architecture/buildermgr.md diff --git a/docs/content/en/docs/concepts/components/core/controller.md b/docs/content/en/docs/architecture/controller.md similarity index 100% rename from docs/content/en/docs/concepts/components/core/controller.md rename to docs/content/en/docs/architecture/controller.md diff --git a/docs/content/en/docs/concepts/components/core/executor.md b/docs/content/en/docs/architecture/executor.md similarity index 99% rename from docs/content/en/docs/concepts/components/core/executor.md rename to docs/content/en/docs/architecture/executor.md index ce2936ca..8f3a62b8 100644 --- a/docs/content/en/docs/concepts/components/core/executor.md +++ b/docs/content/en/docs/architecture/executor.md @@ -128,5 +128,5 @@ Autoscaling is useful for workloads where you expect intermittent spikes in work It also enables optimal the usage of resources to execute functions, by using a baseline capacity with minimum scale and ability to burst up to maximum scale based on spikes in demand. {{% notice info %}} -Learn more further usage/setup of **executor type** for functions, please see [here]({{% ref "../../../usage/executor.en.md" %}}). +Learn more further usage/setup of **executor type** for functions, please see [here]({{% ref "../usage/function/executor.en.md" %}}). {{% /notice %}} diff --git a/docs/content/en/docs/concepts/components/core/function-pod.md b/docs/content/en/docs/architecture/function-pod.md similarity index 100% rename from docs/content/en/docs/concepts/components/core/function-pod.md rename to docs/content/en/docs/architecture/function-pod.md diff --git a/docs/content/en/docs/concepts/components/optional/kubewatcher.md b/docs/content/en/docs/architecture/kubewatcher.md similarity index 98% rename from docs/content/en/docs/concepts/components/optional/kubewatcher.md rename to docs/content/en/docs/architecture/kubewatcher.md index 0f86d10d..de366e83 100644 --- a/docs/content/en/docs/concepts/components/optional/kubewatcher.md +++ b/docs/content/en/docs/architecture/kubewatcher.md @@ -1,6 +1,6 @@ --- title: "KubeWatcher" -weight: 3 +weight: 10 description: > Hawkeye to watch resource changes in Kubernetes cluster --- diff --git a/docs/content/en/docs/concepts/components/optional/logger.md b/docs/content/en/docs/architecture/logger.md similarity index 98% rename from docs/content/en/docs/concepts/components/optional/logger.md rename to docs/content/en/docs/architecture/logger.md index dc841005..c9d7d043 100644 --- a/docs/content/en/docs/concepts/components/optional/logger.md +++ b/docs/content/en/docs/architecture/logger.md @@ -1,6 +1,6 @@ --- title: "Logger" -weight: 2 +weight: 9 description: > Record and persist function logs --- diff --git a/docs/content/en/docs/concepts/components/optional/message-queue-trigger.md b/docs/content/en/docs/architecture/message-queue-trigger.md similarity index 98% rename from docs/content/en/docs/concepts/components/optional/message-queue-trigger.md rename to docs/content/en/docs/architecture/message-queue-trigger.md index ec739485..8f634c42 100644 --- a/docs/content/en/docs/concepts/components/optional/message-queue-trigger.md +++ b/docs/content/en/docs/architecture/message-queue-trigger.md @@ -1,6 +1,6 @@ --- title: "Message Queue Trigger" -weight: 4 +weight: 11 description: > Subscribe topics and invoke functions --- diff --git a/docs/content/en/docs/concepts/components/core/router.md b/docs/content/en/docs/architecture/router.md similarity index 100% rename from docs/content/en/docs/concepts/components/core/router.md rename to docs/content/en/docs/architecture/router.md diff --git a/docs/content/en/docs/concepts/components/core/storagesvc.md b/docs/content/en/docs/architecture/storagesvc.md similarity index 100% rename from docs/content/en/docs/concepts/components/core/storagesvc.md rename to docs/content/en/docs/architecture/storagesvc.md diff --git a/docs/content/en/docs/concepts/components/optional/timer.md b/docs/content/en/docs/architecture/timer.md similarity index 97% rename from docs/content/en/docs/concepts/components/optional/timer.md rename to docs/content/en/docs/architecture/timer.md index c75b7751..e0c22180 100644 --- a/docs/content/en/docs/concepts/components/optional/timer.md +++ b/docs/content/en/docs/architecture/timer.md @@ -1,6 +1,6 @@ --- title: "Timer" -weight: 5 +weight: 12 description: > Invoke functions periodically --- diff --git a/docs/content/en/docs/concepts/_index.md b/docs/content/en/docs/concepts/_index.md index 220fc99b..f7b7178c 100644 --- a/docs/content/en/docs/concepts/_index.md +++ b/docs/content/en/docs/concepts/_index.md @@ -1,8 +1,8 @@ --- title: "Concepts" -weight: 10 +weight: 20 description: > - Concepts of Fission architecture and components + Concepts of Fission architecture --- Fission has three main concepts: **Functions, Environments, and Triggers.** @@ -42,7 +42,7 @@ gathering dependencies. You can modify any of Fission's existing environments and rebuild them, or you can also build a new environment from scratch. -See [here]({{% ref "../languages/" %}}) for the full image list. +See [here]({{% ref "../usage/languages/" %}}) for the full image list. ## Triggers diff --git a/docs/content/en/docs/concepts/components/_index.md b/docs/content/en/docs/concepts/components/_index.md deleted file mode 100644 index e0350273..00000000 --- a/docs/content/en/docs/concepts/components/_index.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -title: "Components" -description: > - Components in details ---- diff --git a/docs/content/en/docs/concepts/components/core/_index.md b/docs/content/en/docs/concepts/components/core/_index.md deleted file mode 100644 index d622f49e..00000000 --- a/docs/content/en/docs/concepts/components/core/_index.md +++ /dev/null @@ -1,6 +0,0 @@ ---- -title: "Core" -weight: 1 -description: > - Core components in details ---- diff --git a/docs/content/en/docs/concepts/components/optional/_index.md b/docs/content/en/docs/concepts/components/optional/_index.md deleted file mode 100644 index 6c65f4a9..00000000 --- a/docs/content/en/docs/concepts/components/optional/_index.md +++ /dev/null @@ -1,6 +0,0 @@ ---- -title: "Optional" -weight: 1 -description: > - Optional components in details ---- diff --git a/docs/content/en/docs/contributing/_index.en.md b/docs/content/en/docs/contributing/_index.en.md index 27a5efba..66c01230 100644 --- a/docs/content/en/docs/contributing/_index.en.md +++ b/docs/content/en/docs/contributing/_index.en.md @@ -1,6 +1,7 @@ --- title: "Contributing to Fission" -weight: 250 +linkTitle: Contributing +weight: 50 description: > Build deploy and contribute to Fission! --- diff --git a/docs/content/en/docs/installation/_index.en.md b/docs/content/en/docs/installation/_index.en.md index afd062a3..00be2b21 100644 --- a/docs/content/en/docs/installation/_index.en.md +++ b/docs/content/en/docs/installation/_index.en.md @@ -1,7 +1,7 @@ --- title: "Installing Fission" -linkTitle: Installing Fission -weight: 20 +linkTitle: Installation +weight: 10 description: > Installation guide for Fission installation --- @@ -257,7 +257,7 @@ $ fission function test --name hello Hello, world! ``` -For more language tutorials, visit [Language]({{% ref "../languages/" %}}). +For more language tutorials, visit [Language]({{% ref "../usage/languages/" %}}). # What's next? diff --git a/docs/content/en/docs/installation/advanced-setup.en.md b/docs/content/en/docs/installation/advanced-setup.en.md index 6fb6d115..070db14b 100644 --- a/docs/content/en/docs/installation/advanced-setup.en.md +++ b/docs/content/en/docs/installation/advanced-setup.en.md @@ -1,6 +1,6 @@ --- title: Advanced Setup -weight: 1 +weight: 50 description: > Advanced setup guide for Fission installation --- diff --git a/docs/content/en/docs/compatibility/_index.md b/docs/content/en/docs/installation/compatibility.md similarity index 95% rename from docs/content/en/docs/compatibility/_index.md rename to docs/content/en/docs/installation/compatibility.md index 42adac70..c1faf695 100644 --- a/docs/content/en/docs/compatibility/_index.md +++ b/docs/content/en/docs/installation/compatibility.md @@ -1,6 +1,6 @@ --- title: "Compatibility" -weight: 1 +weight: 70 description: > Fission Compatibility with environments, Keda and Keda Connectors --- diff --git a/docs/content/en/docs/installation/docker-desktop.md b/docs/content/en/docs/installation/docker-desktop.md index 90ef3591..9edd704a 100644 --- a/docs/content/en/docs/installation/docker-desktop.md +++ b/docs/content/en/docs/installation/docker-desktop.md @@ -1,6 +1,6 @@ --- title: "Docker Desktop" -weight: 7 +weight: 20 description: > Docker Desktop specific setup --- @@ -105,4 +105,4 @@ $ fission fn create --name helloscale --env nodescale --code hello.js --executo --minmemory 64 --maxmemory 128 --mincpu 100 --maxcpu 500 --minscale 1 --maxscale 6 --targetcpu 50 ``` -For more details on autoscaling please [check this section of documentation]({{% ref "../usage/executor.en.md" %}}#autoscaling) +For more details on autoscaling please [check this section of documentation]({{% ref "../usage/function/executor.en.md" %}}#autoscaling) diff --git a/docs/content/en/docs/installation/env_vars.en.md b/docs/content/en/docs/installation/env_vars.en.md index 9bd1a75e..a5ae0f67 100644 --- a/docs/content/en/docs/installation/env_vars.en.md +++ b/docs/content/en/docs/installation/env_vars.en.md @@ -1,6 +1,6 @@ --- title: Environment Variables -weight: 3 +weight: 10 description: > Environment variables used by Fission CLI --- diff --git a/docs/content/en/docs/installation/on-premise-install.md b/docs/content/en/docs/installation/on-premise-install.md index 26cd1954..0231a0ab 100644 --- a/docs/content/en/docs/installation/on-premise-install.md +++ b/docs/content/en/docs/installation/on-premise-install.md @@ -1,6 +1,6 @@ --- title: "Offline On-Premise" -weight: 6 +weight: 10 description: > Installation guide for offline on-premise. --- diff --git a/docs/content/en/docs/installation/openshift.md b/docs/content/en/docs/installation/openshift.md index 86013bf3..f9626e01 100644 --- a/docs/content/en/docs/installation/openshift.md +++ b/docs/content/en/docs/installation/openshift.md @@ -1,6 +1,6 @@ --- title: "OpenShift" -weight: 5 +weight: 30 description: > OpenShift specific setup --- diff --git a/docs/content/en/docs/upgrade/_index.md b/docs/content/en/docs/installation/upgrade.md similarity index 99% rename from docs/content/en/docs/upgrade/_index.md rename to docs/content/en/docs/installation/upgrade.md index c5178983..4e02aace 100644 --- a/docs/content/en/docs/upgrade/_index.md +++ b/docs/content/en/docs/installation/upgrade.md @@ -1,6 +1,6 @@ --- title: "Upgrade Guide" -weight: -1 +weight: 60 description: > Upgrade guidance 1.11 onwards --- diff --git a/docs/content/en/docs/releases/1.4.1.md b/docs/content/en/docs/releases/1.4.1.md index a8651ead..5a7bb38a 100755 --- a/docs/content/en/docs/releases/1.4.1.md +++ b/docs/content/en/docs/releases/1.4.1.md @@ -50,7 +50,7 @@ For details, see [PR#1217](https://github.com/fission/fission/pull/1217) Now, a function will get updated when the referenced configmaps/secrets get updated instead of caching stale data. -For details, see [here]({{% ref "../usage/access-secret-cfgmap-in-function.en.md" %}}#updating-secrets-and-configmaps) and [PR#1224](https://github.com/fission/fission/pull/1224). +For details, see [here]({{% ref "../usage/function/access-secret-cfgmap-in-function.en.md" %}}#updating-secrets-and-configmaps) and [PR#1224](https://github.com/fission/fission/pull/1224). ### Go module support for go environment diff --git a/docs/content/en/docs/releases/_index.en.md b/docs/content/en/docs/releases/_index.en.md index 2276d47a..704dcb5b 100644 --- a/docs/content/en/docs/releases/_index.en.md +++ b/docs/content/en/docs/releases/_index.en.md @@ -1,7 +1,7 @@ --- title: "Release Highlights" linkTitle: Release Highlights -weight: 1 +weight: 70 description: > Highlight for release --- diff --git a/docs/content/en/docs/trouble-shooting/_index.en.md b/docs/content/en/docs/trouble-shooting/_index.en.md index 5de4e181..f42b041a 100644 --- a/docs/content/en/docs/trouble-shooting/_index.en.md +++ b/docs/content/en/docs/trouble-shooting/_index.en.md @@ -1,6 +1,6 @@ --- title: "Troubleshooting" -weight: 70 +weight: 60 description: > Troubleshoot guides --- diff --git a/docs/content/en/docs/usage/_index.en.md b/docs/content/en/docs/usage/_index.en.md index a22f0e79..202159bd 100644 --- a/docs/content/en/docs/usage/_index.en.md +++ b/docs/content/en/docs/usage/_index.en.md @@ -1,5 +1,5 @@ --- -title: "Using Fission" +title: "Usage" weight: 40 description: > Fission usage diff --git a/docs/content/en/docs/usage/function/_index.en.md b/docs/content/en/docs/usage/function/_index.en.md new file mode 100644 index 00000000..088a7090 --- /dev/null +++ b/docs/content/en/docs/usage/function/_index.en.md @@ -0,0 +1,6 @@ +--- +title: "Function" +weight: 10 +description: > + Fission function +--- diff --git a/docs/content/en/docs/usage/access-secret-cfgmap-in-function.en.md b/docs/content/en/docs/usage/function/access-secret-cfgmap-in-function.en.md similarity index 100% rename from docs/content/en/docs/usage/access-secret-cfgmap-in-function.en.md rename to docs/content/en/docs/usage/function/access-secret-cfgmap-in-function.en.md diff --git a/docs/content/en/docs/usage/accessing-url-params.md b/docs/content/en/docs/usage/function/accessing-url-params.md similarity index 100% rename from docs/content/en/docs/usage/accessing-url-params.md rename to docs/content/en/docs/usage/function/accessing-url-params.md diff --git a/docs/content/en/docs/usage/canary-deployments.md b/docs/content/en/docs/usage/function/canary-deployments.md similarity index 100% rename from docs/content/en/docs/usage/canary-deployments.md rename to docs/content/en/docs/usage/function/canary-deployments.md diff --git a/docs/content/en/docs/usage/enabling-istio-on-fission.md b/docs/content/en/docs/usage/function/enabling-istio-on-fission.md similarity index 97% rename from docs/content/en/docs/usage/enabling-istio-on-fission.md rename to docs/content/en/docs/usage/function/enabling-istio-on-fission.md index 2e4d667b..aa8871a4 100644 --- a/docs/content/en/docs/usage/enabling-istio-on-fission.md +++ b/docs/content/en/docs/usage/function/enabling-istio-on-fission.md @@ -29,7 +29,7 @@ $ kubectl label namespace $FISSION_NAMESPACE istio-injection=enabled $ kubectl config set-context $(kubectl config current-context) --namespace=$FISSION_NAMESPACE ``` -Follow the [installation guide]({{% ref "../installation/_index.en.md" %}}) to install fission with flag `enableIstio` true. +Follow the [installation guide]({{% ref "../../installation/_index.en.md" %}}) to install fission with flag `enableIstio` true. ```bash $ helm install --namespace $FISSION_NAMESPACE --set enableIstio=true --name istio-demo diff --git a/docs/content/en/docs/usage/environments.en.md b/docs/content/en/docs/usage/function/environments.en.md similarity index 100% rename from docs/content/en/docs/usage/environments.en.md rename to docs/content/en/docs/usage/function/environments.en.md diff --git a/docs/content/en/docs/usage/executor.en.md b/docs/content/en/docs/usage/function/executor.en.md similarity index 98% rename from docs/content/en/docs/usage/executor.en.md rename to docs/content/en/docs/usage/function/executor.en.md index 022f3f7d..9b2f0587 100644 --- a/docs/content/en/docs/usage/executor.en.md +++ b/docs/content/en/docs/usage/function/executor.en.md @@ -4,7 +4,7 @@ draft: false weight: 45 --- -[Fission Concepts/Function Executors]({{%ref "../concepts/components/core/executor.md" %}}) describes the major difference between executors. +[Fission Concepts/Function Executors]({{%ref "../../architecture/executor.md" %}}) describes the major difference between executors. In this guide, we will go through how to set up/config different executors for function. #### Poolmgr (Pool-based executor) diff --git a/docs/content/en/docs/usage/functions.en.md b/docs/content/en/docs/usage/function/functions.en.md similarity index 98% rename from docs/content/en/docs/usage/functions.en.md rename to docs/content/en/docs/usage/function/functions.en.md index ecfbbfd0..63ea8ecb 100644 --- a/docs/content/en/docs/usage/functions.en.md +++ b/docs/content/en/docs/usage/function/functions.en.md @@ -42,7 +42,7 @@ $ fission route create --function hello --url /hello --name hello trigger '5327e9a7-6d87-4533-a4fb-c67f55b1e492' created ``` -Setup [FISSION_ROUTER]({{% ref "../installation/env_vars.en.md" %}}) environment variable if you haven't already. +Setup [FISSION_ROUTER]({{% ref "../../installation/env_vars.en.md" %}}) environment variable if you haven't already. When you hit this function's URL, you get the expected response: diff --git a/docs/content/en/docs/usage/package.en.md b/docs/content/en/docs/usage/function/package.en.md similarity index 100% rename from docs/content/en/docs/usage/package.en.md rename to docs/content/en/docs/usage/function/package.en.md diff --git a/docs/content/en/docs/usage/private-registry.md b/docs/content/en/docs/usage/function/private-registry.md similarity index 100% rename from docs/content/en/docs/usage/private-registry.md rename to docs/content/en/docs/usage/function/private-registry.md diff --git a/docs/content/en/docs/usage/url-as-archive-source.md b/docs/content/en/docs/usage/function/url-as-archive-source.md similarity index 100% rename from docs/content/en/docs/usage/url-as-archive-source.md rename to docs/content/en/docs/usage/function/url-as-archive-source.md diff --git a/docs/content/en/docs/usage/ingress/_index.md b/docs/content/en/docs/usage/ingress/_index.md index 2220fc96..0a0a7b72 100644 --- a/docs/content/en/docs/usage/ingress/_index.md +++ b/docs/content/en/docs/usage/ingress/_index.md @@ -1,7 +1,8 @@ --- title: "Exposing Functions With Ingress" +linkTitle: Ingress draft: false -weight: 5 +weight: 60 --- Ingress is a Kubernetes built-in resource that allows accessing Kubernetes services from outside of cluster with help of a ingress controller. diff --git a/docs/content/en/docs/languages/_index.md b/docs/content/en/docs/usage/languages/_index.md similarity index 98% rename from docs/content/en/docs/languages/_index.md rename to docs/content/en/docs/usage/languages/_index.md index 4cfcb374..e40b1a21 100644 --- a/docs/content/en/docs/languages/_index.md +++ b/docs/content/en/docs/usage/languages/_index.md @@ -1,5 +1,5 @@ --- -title: "Environments (Languages)" +title: "Languages (Environment)" weight: 50 description: > Tutorial for supported language diff --git a/docs/content/en/docs/languages/go.md b/docs/content/en/docs/usage/languages/go.md similarity index 99% rename from docs/content/en/docs/languages/go.md rename to docs/content/en/docs/usage/languages/go.md index 7292bd81..ebbcf251 100644 --- a/docs/content/en/docs/languages/go.md +++ b/docs/content/en/docs/usage/languages/go.md @@ -10,7 +10,7 @@ In this usage guide we'll cover how to use this environment, write functions, an ### Before you start We'll assume you have Fission and Kubernetes setup. -If not, head over to the [install guide]({{% ref "../installation/_index.en.md" %}}). +If not, head over to the [install guide]({{% ref "../../installation/_index.en.md" %}}). Verify your Fission setup with: ``` bash diff --git a/docs/content/en/docs/languages/java.md b/docs/content/en/docs/usage/languages/java.md similarity index 99% rename from docs/content/en/docs/languages/java.md rename to docs/content/en/docs/usage/languages/java.md index b7fa5bc4..6a3ab8cc 100644 --- a/docs/content/en/docs/languages/java.md +++ b/docs/content/en/docs/usage/languages/java.md @@ -9,7 +9,7 @@ Current JVM environment is based on openjdk8 and uses Spring Boot as framework. ### Before you start We'll assume you have Fission and Kubernetes setup. -If not, head over to the [install guide]({{% ref "../installation/_index.en.md" %}}). +If not, head over to the [install guide]({{% ref "../../installation/_index.en.md" %}}). Verify your Fission setup with: ``` sh diff --git a/docs/content/en/docs/languages/nodejs.md b/docs/content/en/docs/usage/languages/nodejs.md similarity index 99% rename from docs/content/en/docs/languages/nodejs.md rename to docs/content/en/docs/usage/languages/nodejs.md index 15f40388..75206851 100644 --- a/docs/content/en/docs/languages/nodejs.md +++ b/docs/content/en/docs/usage/languages/nodejs.md @@ -10,7 +10,7 @@ In this usage guide we'll cover how to use this environment, write functions, an ### Before you start We assume you have Fission and Kubernetes setup. -If not, head over to the [install guide]({{% ref "../installation/_index.en.md" %}}). +If not, head over to the [install guide]({{% ref "../../installation/_index.en.md" %}}). Verify your Fission setup with: ```bash diff --git a/docs/content/en/docs/languages/python.md b/docs/content/en/docs/usage/languages/python.md similarity index 97% rename from docs/content/en/docs/languages/python.md rename to docs/content/en/docs/usage/languages/python.md index 621d8384..fc54074c 100644 --- a/docs/content/en/docs/languages/python.md +++ b/docs/content/en/docs/usage/languages/python.md @@ -11,7 +11,7 @@ We'll also cover basic troubleshooting. ### Before you start We'll assume you have Fission and Kubernetes setup. -If not, head over to the [installation guide]({{% ref "../installation/_index.en.md" %}}). +If not, head over to the [installation guide]({{% ref "../../installation/_index.en.md" %}}). Verify your Fission setup with: @@ -53,7 +53,7 @@ Hello, world! ``` You can also invoke this function by creating an HTTP trigger and making an HTTP request to the Fission router. -Ensure you have your router's address in the `FISSION_ROUTER` environment variable as [this guide describes]({{% ref "../installation/env_vars.en.md" %}}#fission-router-address). +Ensure you have your router's address in the `FISSION_ROUTER` environment variable as [this guide describes]({{% ref "../../installation/env_vars.en.md" %}}#fission-router-address). Then, ```bash diff --git a/docs/content/en/docs/observability/_index.md b/docs/content/en/docs/usage/observability/_index.md similarity index 89% rename from docs/content/en/docs/observability/_index.md rename to docs/content/en/docs/usage/observability/_index.md index 50dd9e00..1b6e97dd 100644 --- a/docs/content/en/docs/observability/_index.md +++ b/docs/content/en/docs/usage/observability/_index.md @@ -1,6 +1,6 @@ --- title: "Observability" -weight: 70 +weight: 40 description: > Tutorial for observability around Fission --- diff --git a/docs/content/en/docs/observability/assets/fission-linkerd.png b/docs/content/en/docs/usage/observability/assets/fission-linkerd.png similarity index 100% rename from docs/content/en/docs/observability/assets/fission-linkerd.png rename to docs/content/en/docs/usage/observability/assets/fission-linkerd.png diff --git a/docs/content/en/docs/observability/assets/linkerd-after.png b/docs/content/en/docs/usage/observability/assets/linkerd-after.png similarity index 100% rename from docs/content/en/docs/observability/assets/linkerd-after.png rename to docs/content/en/docs/usage/observability/assets/linkerd-after.png diff --git a/docs/content/en/docs/observability/assets/linkerd-before.png b/docs/content/en/docs/usage/observability/assets/linkerd-before.png similarity index 100% rename from docs/content/en/docs/observability/assets/linkerd-before.png rename to docs/content/en/docs/usage/observability/assets/linkerd-before.png diff --git a/docs/content/en/docs/observability/assets/linkerd-dashboard.png b/docs/content/en/docs/usage/observability/assets/linkerd-dashboard.png similarity index 100% rename from docs/content/en/docs/observability/assets/linkerd-dashboard.png rename to docs/content/en/docs/usage/observability/assets/linkerd-dashboard.png diff --git a/docs/content/en/docs/observability/assets/linkerd-demo.mp4 b/docs/content/en/docs/usage/observability/assets/linkerd-demo.mp4 similarity index 100% rename from docs/content/en/docs/observability/assets/linkerd-demo.mp4 rename to docs/content/en/docs/usage/observability/assets/linkerd-demo.mp4 diff --git a/docs/content/en/docs/observability/assets/linkerd-grafana.png b/docs/content/en/docs/usage/observability/assets/linkerd-grafana.png similarity index 100% rename from docs/content/en/docs/observability/assets/linkerd-grafana.png rename to docs/content/en/docs/usage/observability/assets/linkerd-grafana.png diff --git a/docs/content/en/docs/observability/assets/loki-grafana-dashboard.png b/docs/content/en/docs/usage/observability/assets/loki-grafana-dashboard.png similarity index 100% rename from docs/content/en/docs/observability/assets/loki-grafana-dashboard.png rename to docs/content/en/docs/usage/observability/assets/loki-grafana-dashboard.png diff --git a/docs/content/en/docs/observability/assets/prometheus-grafana.png b/docs/content/en/docs/usage/observability/assets/prometheus-grafana.png similarity index 100% rename from docs/content/en/docs/observability/assets/prometheus-grafana.png rename to docs/content/en/docs/usage/observability/assets/prometheus-grafana.png diff --git a/docs/content/en/docs/observability/assets/stack.png b/docs/content/en/docs/usage/observability/assets/stack.png similarity index 100% rename from docs/content/en/docs/observability/assets/stack.png rename to docs/content/en/docs/usage/observability/assets/stack.png diff --git a/docs/content/en/docs/observability/linkerd.md b/docs/content/en/docs/usage/observability/linkerd.md similarity index 100% rename from docs/content/en/docs/observability/linkerd.md rename to docs/content/en/docs/usage/observability/linkerd.md diff --git a/docs/content/en/docs/observability/loki.md b/docs/content/en/docs/usage/observability/loki.md similarity index 100% rename from docs/content/en/docs/observability/loki.md rename to docs/content/en/docs/usage/observability/loki.md diff --git a/docs/content/en/docs/observability/prometheus.md b/docs/content/en/docs/usage/observability/prometheus.md similarity index 100% rename from docs/content/en/docs/observability/prometheus.md rename to docs/content/en/docs/usage/observability/prometheus.md diff --git a/docs/content/en/docs/spec/_index.md b/docs/content/en/docs/usage/spec/_index.md similarity index 98% rename from docs/content/en/docs/spec/_index.md rename to docs/content/en/docs/usage/spec/_index.md index e22ce981..b09ce6eb 100644 --- a/docs/content/en/docs/spec/_index.md +++ b/docs/content/en/docs/usage/spec/_index.md @@ -1,6 +1,6 @@ --- -title: "Declarative Specifications (Spec)" -weight: 60 +title: "YAML Specs" +weight: 30 description: > Source Code Organization and Your Development Workflow --- @@ -53,7 +53,7 @@ We'll see examples of all these commands in the tutorial below. ## Tutorial This tutorial assumes you've already set up Fission, and tested a simple hello world function to make sure everything's working. -To learn how to do that, head over to the [installation guide]({{% ref "../installation" %}}). +To learn how to do that, head over to the [installation guide]({{% ref "../../installation" %}}). We'll make a small calculator app with one python environment and two functions, all of which will be declaratively specified using YAML files. This is a somewhat contrived example, but it is just meant as an illustration. @@ -293,7 +293,7 @@ On the cluster, Archives are tracked with checksums; the Fission CLI only upload ## Improve Portability of Spec (1.7.0+) Sometimes you may want to release spec files only without the function source code or the compiled binary. -To improve the portability, you can specify a URL that points to the target archive by following the step described in [here]({{% ref "../usage/url-as-archive-source.md" %}}). +To improve the portability, you can specify a URL that points to the target archive by following the step described in [here]({{% ref "../function/url-as-archive-source.md" %}}). ## More Examples diff --git a/docs/content/en/docs/spec/podspec/_index.md b/docs/content/en/docs/usage/spec/podspec/_index.md similarity index 100% rename from docs/content/en/docs/spec/podspec/_index.md rename to docs/content/en/docs/usage/spec/podspec/_index.md diff --git a/docs/content/en/docs/spec/podspec/containers.md b/docs/content/en/docs/usage/spec/podspec/containers.md similarity index 100% rename from docs/content/en/docs/spec/podspec/containers.md rename to docs/content/en/docs/usage/spec/podspec/containers.md diff --git a/docs/content/en/docs/spec/podspec/envvar.md b/docs/content/en/docs/usage/spec/podspec/envvar.md similarity index 100% rename from docs/content/en/docs/spec/podspec/envvar.md rename to docs/content/en/docs/usage/spec/podspec/envvar.md diff --git a/docs/content/en/docs/spec/podspec/toleration.md b/docs/content/en/docs/usage/spec/podspec/toleration.md similarity index 100% rename from docs/content/en/docs/spec/podspec/toleration.md rename to docs/content/en/docs/usage/spec/podspec/toleration.md diff --git a/docs/content/en/docs/spec/podspec/volume.md b/docs/content/en/docs/usage/spec/podspec/volume.md similarity index 100% rename from docs/content/en/docs/spec/podspec/volume.md rename to docs/content/en/docs/usage/spec/podspec/volume.md diff --git a/docs/content/en/docs/triggers/_index.md b/docs/content/en/docs/usage/triggers/_index.md similarity index 98% rename from docs/content/en/docs/triggers/_index.md rename to docs/content/en/docs/usage/triggers/_index.md index 74b8dec7..6c4dc48b 100644 --- a/docs/content/en/docs/triggers/_index.md +++ b/docs/content/en/docs/usage/triggers/_index.md @@ -1,6 +1,6 @@ --- title: "Triggers" -weight: 43 +weight: 20 description: > Supported event triggers --- diff --git a/docs/content/en/docs/triggers/assets/message-queue-trigger.png b/docs/content/en/docs/usage/triggers/assets/message-queue-trigger.png similarity index 100% rename from docs/content/en/docs/triggers/assets/message-queue-trigger.png rename to docs/content/en/docs/usage/triggers/assets/message-queue-trigger.png diff --git a/docs/content/en/docs/triggers/assets/mqt-kind-keda.png b/docs/content/en/docs/usage/triggers/assets/mqt-kind-keda.png similarity index 100% rename from docs/content/en/docs/triggers/assets/mqt-kind-keda.png rename to docs/content/en/docs/usage/triggers/assets/mqt-kind-keda.png diff --git a/docs/content/en/docs/triggers/http-trigger.md b/docs/content/en/docs/usage/triggers/http-trigger.md similarity index 93% rename from docs/content/en/docs/triggers/http-trigger.md rename to docs/content/en/docs/usage/triggers/http-trigger.md index 9f0c472c..3580e6b9 100644 --- a/docs/content/en/docs/triggers/http-trigger.md +++ b/docs/content/en/docs/usage/triggers/http-trigger.md @@ -19,7 +19,7 @@ Hello World! {{% notice info %}} FISSION_ROUTER is the externally-visible address of your Fission router service. For how to set up environment variable -`FISSION_ROUTER`, see [here]({{% ref "../installation/env_vars.en.md" %}}) +`FISSION_ROUTER`, see [here]({{% ref "../../installation/env_vars.en.md" %}}) {{% /notice %}} Also, we can create a trigger contains URL parameter by putting placeholders in value of `--url` flag. @@ -37,7 +37,7 @@ $ fission httptrigger create --method GET \ ``` {{% notice info %}} -Learn how to access URL parameters in function to develop a **REST API**, please visit [here]({{% ref "../usage/accessing-url-params.md" %}}) +Learn how to access URL parameters in function to develop a **REST API**, please visit [here]({{% ref "../function/accessing-url-params.md" %}}) {{% /notice %}} If you want to use Kubernetes Ingress for the HTTP Trigger, you can provide the `--createingress` flag and a hostname. diff --git a/docs/content/en/docs/triggers/kubewatcher.md b/docs/content/en/docs/usage/triggers/kubewatcher.md similarity index 100% rename from docs/content/en/docs/triggers/kubewatcher.md rename to docs/content/en/docs/usage/triggers/kubewatcher.md diff --git a/docs/content/en/docs/triggers/message-queue-trigger-kind-keda/_index.md b/docs/content/en/docs/usage/triggers/message-queue-trigger-kind-keda/_index.md similarity index 100% rename from docs/content/en/docs/triggers/message-queue-trigger-kind-keda/_index.md rename to docs/content/en/docs/usage/triggers/message-queue-trigger-kind-keda/_index.md diff --git a/docs/content/en/docs/triggers/message-queue-trigger-kind-keda/aws-kinesis.md b/docs/content/en/docs/usage/triggers/message-queue-trigger-kind-keda/aws-kinesis.md similarity index 98% rename from docs/content/en/docs/triggers/message-queue-trigger-kind-keda/aws-kinesis.md rename to docs/content/en/docs/usage/triggers/message-queue-trigger-kind-keda/aws-kinesis.md index 95deadaf..e787c19e 100644 --- a/docs/content/en/docs/triggers/message-queue-trigger-kind-keda/aws-kinesis.md +++ b/docs/content/en/docs/usage/triggers/message-queue-trigger-kind-keda/aws-kinesis.md @@ -6,7 +6,7 @@ weight: 3 This tutorial will demonstrate how to use a AWS Kinesis trigger to invoke a function. We'll assume you have Fission and Kubernetes installed. -If not, please head over to the [install guide]({{% ref "../../installation/_index.en.md" %}}). +If not, please head over to the [install guide]({{% ref "../../../installation/_index.en.md" %}}). You will also need AWS Kinesis setup which is reachable from the Fission Kubernetes cluster. diff --git a/docs/content/en/docs/triggers/message-queue-trigger-kind-keda/aws-sqs.md b/docs/content/en/docs/usage/triggers/message-queue-trigger-kind-keda/aws-sqs.md similarity index 98% rename from docs/content/en/docs/triggers/message-queue-trigger-kind-keda/aws-sqs.md rename to docs/content/en/docs/usage/triggers/message-queue-trigger-kind-keda/aws-sqs.md index 1e488b49..b78cc961 100644 --- a/docs/content/en/docs/triggers/message-queue-trigger-kind-keda/aws-sqs.md +++ b/docs/content/en/docs/usage/triggers/message-queue-trigger-kind-keda/aws-sqs.md @@ -6,7 +6,7 @@ weight: 2 This tutorial will demonstrate how to use a AWS SQS trigger to invoke a function. We'll assume you have Fission and Kubernetes installed. -If not, please head over to the [install guide]({{% ref "../../installation/_index.en.md" %}}). +If not, please head over to the [install guide]({{% ref "../../../installation/_index.en.md" %}}). You will also need AWS SQS setup which is reachable from the Fission Kubernetes cluster. diff --git a/docs/content/en/docs/triggers/message-queue-trigger-kind-keda/nats-streaming.md b/docs/content/en/docs/usage/triggers/message-queue-trigger-kind-keda/nats-streaming.md similarity index 98% rename from docs/content/en/docs/triggers/message-queue-trigger-kind-keda/nats-streaming.md rename to docs/content/en/docs/usage/triggers/message-queue-trigger-kind-keda/nats-streaming.md index 1dce50ed..8a48e69a 100644 --- a/docs/content/en/docs/triggers/message-queue-trigger-kind-keda/nats-streaming.md +++ b/docs/content/en/docs/usage/triggers/message-queue-trigger-kind-keda/nats-streaming.md @@ -6,7 +6,7 @@ weight: 4 This tutorial will demonstrate how to use a NATS Streaming trigger to invoke a function. We'll assume you have Fission and Kubernetes installed. -If not, please head over to the [install guide]({{% ref "../../installation/_index.en.md" %}}). +If not, please head over to the [install guide]({{% ref "../../../installation/_index.en.md" %}}). You will also need NATS Streaming server setup which is reachable from the Fission Kubernetes cluster. diff --git a/docs/content/en/docs/triggers/message-queue-trigger/_index.md b/docs/content/en/docs/usage/triggers/message-queue-trigger/_index.md similarity index 100% rename from docs/content/en/docs/triggers/message-queue-trigger/_index.md rename to docs/content/en/docs/usage/triggers/message-queue-trigger/_index.md diff --git a/docs/content/en/docs/triggers/message-queue-trigger/assets/nats-example.png b/docs/content/en/docs/usage/triggers/message-queue-trigger/assets/nats-example.png similarity index 100% rename from docs/content/en/docs/triggers/message-queue-trigger/assets/nats-example.png rename to docs/content/en/docs/usage/triggers/message-queue-trigger/assets/nats-example.png diff --git a/docs/content/en/docs/triggers/message-queue-trigger/kafka.md b/docs/content/en/docs/usage/triggers/message-queue-trigger/kafka.md similarity index 98% rename from docs/content/en/docs/triggers/message-queue-trigger/kafka.md rename to docs/content/en/docs/usage/triggers/message-queue-trigger/kafka.md index 37ac222d..50140cac 100644 --- a/docs/content/en/docs/triggers/message-queue-trigger/kafka.md +++ b/docs/content/en/docs/usage/triggers/message-queue-trigger/kafka.md @@ -6,7 +6,7 @@ weight: 77 This tutorial will demonstrate how to use a Kafka trigger to invoke a function. We'll assume you have Fission and Kubernetes installed with Kafka MQ integration installed. -If not, please head over to the [install guide]({{% ref "../../installation/_index.en.md" %}}). +If not, please head over to the [install guide]({{% ref "../../../installation/_index.en.md" %}}). You will also need Kafka setup which is reachable from the Fission Kubernetes cluster. If you want to setup Kafka on the Kubernetes cluster, you can use the [information here](https://github.com/fission/fission-kafka-sample/tree/master/00_setup). diff --git a/docs/content/en/docs/triggers/message-queue-trigger/nats-streaming.md b/docs/content/en/docs/usage/triggers/message-queue-trigger/nats-streaming.md similarity index 100% rename from docs/content/en/docs/triggers/message-queue-trigger/nats-streaming.md rename to docs/content/en/docs/usage/triggers/message-queue-trigger/nats-streaming.md diff --git a/docs/content/en/docs/triggers/timer.md b/docs/content/en/docs/usage/triggers/timer.md similarity index 100% rename from docs/content/en/docs/triggers/timer.md rename to docs/content/en/docs/usage/triggers/timer.md diff --git a/docs/content/en/docs/workflows/_index.en.md b/docs/content/en/docs/workflows/_index.en.md deleted file mode 100644 index b6bbf549..00000000 --- a/docs/content/en/docs/workflows/_index.en.md +++ /dev/null @@ -1,159 +0,0 @@ ---- -title: "Fission Workflows" -weight: 99 -description: > - Workflow system on top of Fission ---- - -{{% notice info %}} -Fission Workflow only supports Fission 0.4.1 ~ 0.12.0 -{{% /notice %}} - -#### Prerequisites - -Fission Workflows requires the following components to be installed on your local machine: - -- [kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl/) -- [helm](https://github.com/kubernetes/helm) - -Fission Workflows is deployed on top of a Kubernetes cluster. -It requires a [Fission](https://github.com/fission/fission) deployment to be present on your Kubernetes cluster. -If you do not have a Fission deployment, follow [Fission's installation guide]({{% ref "../installation/_index.en.md" %}}). -**(Note that Fission Workflows 0.6.0 requires Fission 0.4.1 or higher, with the NATS component installed!)** - -#### Installing Fission Workflows - -Fission Workflows is an add-on to Fission. -You can install both Fission and Fission Workflows using helm charts. - -Assuming you have your Kubernetes cluster set up with a functioning deployment of Fission 0.4.1 or higher, run the following commands: - -```bash -# If you haven't already, add the Fission charts repo -$ helm repo add fission-charts https://fission.github.io/fission-charts/ - -$ helm repo update - -# Install Fission Workflows -$ helm install --wait -n fission-workflows fission-charts/fission-workflows --version 0.6.0 -``` - -#### Creating your first workflow - -After installing Fission and Workflows, you're all set to run a simple test workflow. -With the following code snippet you will be able to deploy and run a small workflow example: - -```bash -# Fetch the required files, alternatively you could clone the fission-workflow repo -$ curl https://raw.githubusercontent.com/fission/fission-workflows/0.6.0/examples/whales/fortune.sh > fortune.sh - -$ curl https://raw.githubusercontent.com/fission/fission-workflows/0.6.0/examples/whales/whalesay.sh > whalesay.sh - -$ curl https://raw.githubusercontent.com/fission/fission-workflows/0.6.0/examples/whales/fortunewhale.wf.yaml > fortunewhale.wf.yaml - -# -# Add binary environment and create two test functions on your Fission setup: -# -$ fission env create --name binary --image fission/binary-env - -$ fission function create --name whalesay --env binary --deploy ./whalesay.sh - -$ fission function create --name fortune --env binary --deploy ./fortune.sh - -# -# Create a workflow that uses those two functions. A workflow is just -# a function that uses the "workflow" environment. -# -$ fission function create --name fortunewhale --env workflow --src ./fortunewhale.wf.yaml - -# -# Map an HTTP GET to your new workflow function: -# -$ fission route create --method GET --url /fortunewhale --function fortunewhale - -# -# Invoke the workflow with an HTTP request: -# -$ curl ${FISSION_ROUTER}/fortunewhale -``` - -This last command, the invocation of the workflow, should return a whale saying something wise: - -```text - ______________________________________ -/ Anthony's Law of Force: \ -| | -\ Don't force it; get a larger hammer. / - -------------------------------------- - \ - \ - \ - ## . - ## ## ## == - ## ## ## ## ## === - /"""""""""""""""""\___/ === - { / ===- - \______ O __/ - \ \ __/ - \____\_______/ -``` - -So what happened here? -Let's see what the workflow consists of (for example by running `cat fortunewhale.wf.yaml`): - -```yaml -# This whale shows off a basic workflow that combines both Fission Functions (fortune, whalesay) and internal functions (noop) -apiVersion: 1 -output: WhaleWithFortune -tasks: - InternalFuncShowoff: - run: noop - - GenerateFortune: - run: fortune - requires: - - InternalFuncShowoff - - WhaleWithFortune: - run: whalesay - inputs: "{$.Tasks.GenerateFortune.Output}" - requires: - - GenerateFortune -``` - -What you see is the [YAML](http://yaml.org/)-based workflow definition of the `fortunewhale` workflow. -A workflow consists of multiple tasks, which are steps that it needs to complete. -Each task has a unique identifier, such as `GenerateFortune`, a reference to a Fission function in the `run` field. -Optionally, it can contain `inputs` which allows you to specify inputs to the task, as well as contain `requires` which allows you to specify which tasks need to complete before this task can start. -Finally, at the top you will find the `output` field, which specifies the task whose output is used as the workflow's output. - -In this case, the `fortunewhale` workflow consists of a sequence of 3 tasks: - -```text -InternalFuncShowoff -> GenerateFortune -> WhaleWithFortune -``` - -First, it starts with `InternalFuncShowoff` by running `noop`, which is an *internal function* in the workflow engine. -Internal functions are run inside of the workflow engine, which makes them run much faster at the cost of expressiveness and scalability. -So typically, light-weight functions, such as logic or control flow operations, are good candidates to be used as internal functions. -Besides, a minimal set of predefined internal functions, you can define internal function - there is nothing special about them. - -After `InternalFuncShowff` completes, the `GenerateFortune` task can start as its `requires` has been fulfilled. -It runs the `fortune` Fission function, which outputs a random piece of wisdom. - -After `GenerateFortune` completes, the `WhaleWithFortune` task can start. -This task uses a javascript expression in its `inputs` to reference the output of the `GenerateFortune` task. -In the inputs of a task you can reference anything in the workflow, such as outputs, inputs, and task definitions, or just provide a constant value. -The workflow engine invokes the `whalesay` fission function with as input the piece of wisdom, which outputs the ASCI whale that wraps the phrase. - -Finally, with all tasks completed, the workflow engine uses the top-level `output` field to fetch the output of the `WhaleWithFortune` and return it to the user. -As the workflow engine adheres to the Fission function specification, a Fission workflow is just another Fission Function. -This means that you could use this workflow as a function in the `run` in other workflows. - -#### What's next? - -To learn more about the Fission Workflows system and its advanced concepts, see the [documentation on Github](https://github.com/fission/fission-workflows/tree/master/Docs). - -Or, check out the [examples](https://github.com/fission/fission-workflows/tree/0.6.0/examples) for more example workflows. - -If something went wrong, we'd love to help -- please [drop by the slack channel](https://join.slack.com/t/fissionio/shared_invite/enQtOTI3NjgyMjE5NzE3LTllODJiODBmYTBiYWUwMWQxZWRhNDhiZDMyN2EyNjAzMTFiYjE2Nzc1NzE0MTU4ZTg2MzVjMDQ1NWY3MGJhZmE) and ask for help.