diff --git a/.github/workflows/knative-boilerplate.yaml b/.github/workflows/knative-boilerplate.yaml index b08200983..f901369ff 100644 --- a/.github/workflows/knative-boilerplate.yaml +++ b/.github/workflows/knative-boilerplate.yaml @@ -42,10 +42,10 @@ jobs: steps: - - name: Set up Go 1.15.x + - name: Set up Go 1.16.x uses: actions/setup-go@v2 with: - go-version: 1.15.x + go-version: 1.16.x id: go - name: Check out code diff --git a/.github/workflows/knative-go-build.yaml b/.github/workflows/knative-go-build.yaml index c792c1bef..47e0f99eb 100644 --- a/.github/workflows/knative-go-build.yaml +++ b/.github/workflows/knative-go-build.yaml @@ -27,7 +27,7 @@ jobs: name: Build strategy: matrix: - go-version: [1.15.x] + go-version: [1.16.x] platform: [ubuntu-latest] runs-on: ${{ matrix.platform }} @@ -43,7 +43,13 @@ jobs: - name: Check out code uses: actions/checkout@v2 + - id: go_mod + uses: andstor/file-existence-action@v1 + with: + files: go.mod + - name: Build + if: ${{ steps.go_mod.outputs.files_exists == 'true' }} run: | tags="$(grep -I -r '// +build' . | \ grep -v '^./vendor/' | \ @@ -55,5 +61,4 @@ jobs: tr '\n' ' ')" echo "Building with tags: ${tags}" - go test -vet=off -tags "${tags}" -run=^$ ./... | grep -v "no test" || true - + go test -vet=off -tags "${tags}" -exec echo ./... diff --git a/.github/workflows/knative-go-test.yaml b/.github/workflows/knative-go-test.yaml index c62281022..9171315fd 100644 --- a/.github/workflows/knative-go-test.yaml +++ b/.github/workflows/knative-go-test.yaml @@ -31,7 +31,7 @@ jobs: name: Unit Tests strategy: matrix: - go-version: [1.15.x] + go-version: [1.16.x] platform: [ubuntu-latest] runs-on: ${{ matrix.platform }} diff --git a/.github/workflows/knative-releasability.yaml b/.github/workflows/knative-releasability.yaml index 5a30c913f..5e064c4c4 100644 --- a/.github/workflows/knative-releasability.yaml +++ b/.github/workflows/knative-releasability.yaml @@ -36,8 +36,8 @@ jobs: env: ######################################### # Update this section each release. # - RELEASE: 'v0.22' - SLACK_CHANNEL: 'release-22' + RELEASE: 'v0.23' + SLACK_CHANNEL: 'release-23' ######################################### steps: @@ -54,10 +54,10 @@ jobs: echo "SLACK_WEBHOOK=exists" >> $GITHUB_ENV fi - - name: Set up Go 1.15.x + - name: Set up Go 1.16.x uses: actions/setup-go@v2 with: - go-version: 1.15.x + go-version: 1.16.x - name: Install Dependencies run: GO111MODULE=on go get knative.dev/test-infra/buoy@main @@ -110,25 +110,15 @@ jobs: # If we don't run `git status` before the "git diff-index" it seems # to list every file that's been touched by codegen. git status - FOUND_DIFF=0 - for x in $(git diff-index --name-only HEAD --); do - if [ "$(basename $x)" = "go.mod" ]; then - continue - elif [ "$(basename $x)" = "go.sum" ]; then - continue - elif [ "$(basename $x)" = "modules.txt" ]; then - continue - fi - echo "Found non-module diff: $x" - FOUND_DIFF=1 - break - done + + CHANGED="$(git diff-index --name-only HEAD --)" # If we see no changes after the upgrade, then we are up to date. - if [[ "$FOUND_DIFF" -eq "0" ]]; then + if [[ "$CHANGED" == "" ]]; then echo "VERIFY_MESSAGE=${{ github.repository }} up to date." >> $GITHUB_ENV else echo "VERIFY_MESSAGE=${{ github.repository }} is out of date." >> $GITHUB_ENV + echo "The following files are changed: $CHANGED" echo 'current=false' >> $GITHUB_ENV fi diff --git a/.github/workflows/knative-release-notes.yaml b/.github/workflows/knative-release-notes.yaml index 517f429bc..172eb390c 100644 --- a/.github/workflows/knative-release-notes.yaml +++ b/.github/workflows/knative-release-notes.yaml @@ -41,7 +41,7 @@ jobs: - name: Set up Go uses: actions/setup-go@v2 with: - go-version: 1.15.x + go-version: 1.16.x - name: Install Dependencies run: GO111MODULE=on go get k8s.io/release/cmd/release-notes diff --git a/.github/workflows/knative-style.yaml b/.github/workflows/knative-style.yaml index 6c0e08679..79828d3d4 100644 --- a/.github/workflows/knative-style.yaml +++ b/.github/workflows/knative-style.yaml @@ -40,10 +40,10 @@ jobs: importpath: golang.org/x/tools/cmd/goimports steps: - - name: Set up Go 1.15.x + - name: Set up Go 1.16.x uses: actions/setup-go@v2 with: - go-version: 1.15.x + go-version: 1.16.x id: go - name: Check out code @@ -89,10 +89,10 @@ jobs: runs-on: ubuntu-latest steps: - - name: Set up Go 1.15.x + - name: Set up Go 1.16.x uses: actions/setup-go@v2 with: - go-version: 1.15.x + go-version: 1.16.x id: go - name: Check out code diff --git a/.github/workflows/knative-verify.yaml b/.github/workflows/knative-verify.yaml index 448c66ba0..945712342 100644 --- a/.github/workflows/knative-verify.yaml +++ b/.github/workflows/knative-verify.yaml @@ -27,7 +27,7 @@ jobs: name: Verify Deps and Codegen strategy: matrix: - go-version: [1.15.x] + go-version: [1.16.x] platform: [ubuntu-latest] runs-on: ${{ matrix.platform }} diff --git a/OWNERS b/OWNERS index 058afec8a..d0fea6ccc 100644 --- a/OWNERS +++ b/OWNERS @@ -4,6 +4,8 @@ approvers: - docs-writers - technical-oversight-committee - steering-committee +- knative-release-leads +- ux-wg-leads reviewers: - docs-writers - docs-reviewers diff --git a/OWNERS_ALIASES b/OWNERS_ALIASES index b1054f458..a5693e357 100644 --- a/OWNERS_ALIASES +++ b/OWNERS_ALIASES @@ -167,12 +167,10 @@ aliases: pkg-configmap-reviewers: - dprotaso - mattmoor - - mdemirhan - vagababov pkg-configmap-writers: - dprotaso - mattmoor - - mdemirhan - vagababov pkg-controller-reviewers: - dprotaso @@ -209,11 +207,9 @@ aliases: - evankanderson - julz serving-observability-reviewers: - - mdemirhan - skonto - yanweiguo serving-observability-writers: - - mdemirhan - yanweiguo serving-reviewers: - julz diff --git a/blog/articles/set-up-a-local-knative-environment-with-kind.md b/blog/articles/set-up-a-local-knative-environment-with-kind.md index 0bbbea40b..b8a3c66db 100644 --- a/blog/articles/set-up-a-local-knative-environment-with-kind.md +++ b/blog/articles/set-up-a-local-knative-environment-with-kind.md @@ -218,15 +218,15 @@ kourier.ingress.networking.knative.dev To get the same experience that you would when using a cluster that has DNS names set up, you can add a “magic” DNS provider. -_nip.io_ provides a wildcard DNS setup that will automatically resolve to the IP address you put in front of nip.io. +_sslip.io_ provides a wildcard DNS setup that will automatically resolve to the IP address you put in front of sslip.io. -To patch the domain configuration for Knative Serving using nip.io, enter the command: +To patch the domain configuration for Knative Serving using sslip.io, enter the command: ```bash $ kubectl patch configmap/config-domain \ --namespace knative-serving \ --type merge \ - --patch '{"data":{"127.0.0.1.nip.io":""}}' + --patch '{"data":{"127.0.0.1.sslip.io":""}}' ``` If you want to validate that the patch command was successful, run the command: @@ -239,7 +239,7 @@ $ kubectl describe configmap/config-domain --namespace knative-serving ... (abbreviated for readability) Data ==== -127.0.0.1.nip.io: +127.0.0.1.sslip.io: ---- ... ``` @@ -329,12 +329,12 @@ $ kubectl get ksvc ```bash NAME URL LATESTCREATED LATESTREADY READY REASON -helloworld-go http://helloworld-go.default.127.0.0.1.nip.io helloworld-go-fqqs6 Unknown RevisionMissing +helloworld-go http://helloworld-go.default.127.0.0.1.sslip.io helloworld-go-fqqs6 Unknown RevisionMissing ``` ```bash NAME URL LATESTCREATED LATESTREADY READY REASON -helloworld-go http://helloworld-go.default.127.0.0.1.nip.io helloworld-go-fqqs6 helloworld-go-fqqs6 True +helloworld-go http://helloworld-go.default.127.0.0.1.sslip.io helloworld-go-fqqs6 helloworld-go-fqqs6 True ``` The final step is to test your application, by checking that the code returns what you expect. You can do this by sending a cURL request to the URL listed above. @@ -342,7 +342,7 @@ The final step is to test your application, by checking that the code returns wh Because this example mapped port 80 of the host to be forwarded to the cluster and set the DNS, you can use the exact URL. ```bash -$ curl -v http://helloworld-go.default.127.0.0.1.nip.io +$ curl -v http://helloworld-go.default.127.0.0.1.sslip.io ``` ```bash diff --git a/community/samples/_index.md b/community/samples/_index.md index 72187cda7..6060e06ee 100644 --- a/community/samples/_index.md +++ b/community/samples/_index.md @@ -14,7 +14,7 @@ something isn't working, lend a helping hand and fix it in a PR. [Learn more about the lifespan of samples](https://github.com/knative/docs/tree/main/CONTRIBUTING.md#user-focused-content) -[**See all Knative code samples**](../../docs/samples.md) +[**See all Knative code samples**](../../docs/samples) ### Interactive serving sample @@ -30,7 +30,7 @@ Knative Serving sample apps. | Sample Name | Description | Language(s) | | ----------- | ----------- | ----------- | -| Hello World | A quick introduction to Knative Serving that highlights how to deploy an app. | [Clojure](./serving/helloworld-clojure/README.md), [Dart](./serving/helloworld-dart/README.md), [Elixir](./serving/helloworld-elixir/README.md), [Haskell](./serving/helloworld-haskell/README.md), [Java - Micronaut](./serving/helloworld-java-micronaut/README.md), [Java - Quarkus](./serving/helloworld-java-quarkus/README.md), [R - Go Server](./serving/helloworld-r/README.md), [Rust](./serving/helloworld-rust/README.md), [Swift](./serving/helloworld-swift/README.md), [Vertx](./serving/helloworld-vertx/README.md) | +| Hello World | A quick introduction to Knative Serving that highlights how to deploy an app. | [Clojure](./serving/helloworld-clojure/), [Dart](./serving/helloworld-dart/), [Elixir](./serving/helloworld-elixir/), [Haskell](./serving/helloworld-haskell/), [Java - Micronaut](./serving/helloworld-java-micronaut/), [Java - Quarkus](./serving/helloworld-java-quarkus/), [R - Go Server](./serving/helloworld-r/), [Rust](./serving/helloworld-rust/), [Swift](./serving/helloworld-swift/), [Vertx](./serving/helloworld-vertx/) | | Machine Learning | A quick introduction to using Knative Serving to serve machine learning models | [Python - BentoML](./serving/machinelearning-python-bentoml) #### Eventing and Eventing Resources samples @@ -45,4 +45,3 @@ Knative `kn` Client sample workflows and apps. | Sample Name | Description | | ----------- | ----------- | | [knfun](https://github.com/maximilien/knfun) | Knative micro-functions (Twitter and Watson APIs) demo using the `kn` client. | - diff --git a/community/samples/serving/helloworld-clojure/index.md b/community/samples/serving/helloworld-clojure/index.md index f9dabb47e..c7d069d00 100644 --- a/community/samples/serving/helloworld-clojure/index.md +++ b/community/samples/serving/helloworld-clojure/index.md @@ -12,7 +12,7 @@ specified, it will use "World" as the TARGET. ## Prerequisites - A Kubernetes cluster with Knative installed and DNS configured. Follow the - [installation instructions](../../../../docs/install/README.md) if you need to create + [installation instructions](../../../../docs/install/) if you need to create one. - [Docker](https://www.docker.com) installed and running on your local machine, and a Docker Hub account configured (we'll use it for a container registry). @@ -142,14 +142,14 @@ folder) you're ready to build and deploy the sample app. ``` kubectl get ksvc helloworld-clojure --output=custom-columns=NAME:.metadata.name,URL:.status.url NAME URL - helloworld-clojure http://helloworld-clojure.default.1.2.3.4.xip.io + helloworld-clojure http://helloworld-clojure.default.1.2.3.4.sslip.io ``` 1. Now you can make a request to your app and see the result. Replace the URL below with the URL returned in the previous command. ```shell - curl http://helloworld-clojure.default.1.2.3.4.xip.io + curl http://helloworld-clojure.default.1.2.3.4.sslip.io Hello World! ``` @@ -160,4 +160,3 @@ To remove the sample app from your cluster, delete the service record: ```shell kubectl delete --filename service.yaml ``` - diff --git a/community/samples/serving/helloworld-dart/index.md b/community/samples/serving/helloworld-dart/index.md index c87ca8e35..24c05dfe5 100644 --- a/community/samples/serving/helloworld-dart/index.md +++ b/community/samples/serving/helloworld-dart/index.md @@ -13,7 +13,7 @@ that you can use for testing. It reads in the env variable `TARGET` and prints ## Prerequisites - A Kubernetes cluster with Knative installed and DNS configured. Follow the - [installation instructions](../../../../docs/install/README.md) if you need to create + [installation instructions](../../../../docs/install/) if you need to create one. - [Docker](https://www.docker.com) installed and running on your local machine, and a Docker Hub account configured (we'll use it for a container registry). @@ -140,14 +140,14 @@ folder) you're ready to build and deploy the sample app. ``` kubectl get ksvc helloworld-dart --output=custom-columns=NAME:.metadata.name,URL:.status.url NAME URL - helloworld-dart http://helloworld-dart.default.1.2.3.4.xip.io + helloworld-dart http://helloworld-dart.default.1.2.3.4.sslip.io ``` 1. Now you can make a request to your app and see the result. Replace the URL below with the URL returned in the previous command. ```shell - curl http://helloworld-dart.default.1.2.3.4.xip.io + curl http://helloworld-dart.default.1.2.3.4.sslip.io Hello Dart Sample v1 ``` diff --git a/community/samples/serving/helloworld-deno/index.md b/community/samples/serving/helloworld-deno/index.md index d58fe6840..9171d2254 100644 --- a/community/samples/serving/helloworld-deno/index.md +++ b/community/samples/serving/helloworld-deno/index.md @@ -19,7 +19,7 @@ cd knative-docs/docs/serving/samples/hello-world/helloworld-deno ## Before you begin - A Kubernetes cluster with Knative installed. Follow the - [installation instructions](../../../../docs/install/README.md) if you need to + [installation instructions](../../../../docs/install/) if you need to create one. - [Docker](https://www.docker.com) installed and running on your local machine, and a Docker Hub account configured (we'll use it for a container registry). @@ -121,20 +121,20 @@ folder) you're ready to build and deploy the sample app. ```shell NAME URL - helloworld-deno http://helloworld-deno.default.1.2.3.4.xip.io + helloworld-deno http://helloworld-deno.default.1.2.3.4.sslip.io ``` 1. Now you can make a request to your app and see the result. Replace the URL below with the URL returned in the previous command. ```shell - curl http://helloworld-deno.default.1.2.3.4.xip.io + curl http://helloworld-deno.default.1.2.3.4.sslip.io ``` Example: ```shell - curl http://helloworld-deno.default.1.2.3.4.xip.io + curl http://helloworld-deno.default.1.2.3.4.sslip.io [1] "Hello R Sample v1!" ``` @@ -147,4 +147,3 @@ To remove the sample app from your cluster, delete the service record: ```shell kubectl delete --filename service.yaml ``` - diff --git a/community/samples/serving/helloworld-elixir/index.md b/community/samples/serving/helloworld-elixir/index.md index df9d95f7f..6c7d6dd46 100644 --- a/community/samples/serving/helloworld-elixir/index.md +++ b/community/samples/serving/helloworld-elixir/index.md @@ -166,14 +166,14 @@ above. kubectl get ksvc helloworld-elixir --output=custom-columns=NAME:.metadata.name,URL:.status.url NAME URL - helloworld-elixir http://helloworld-elixir.default.1.2.3.4.xip.io + helloworld-elixir http://helloworld-elixir.default.1.2.3.4.sslip.io ``` 1. Now you can make a request to your app to see the results. Replace `{IP_ADDRESS}` with the address you see returned in the previous step. ```shell - curl http://helloworld-elixir.default.1.2.3.4.xip.io + curl http://helloworld-elixir.default.1.2.3.4.sslip.io ... # HTML from your application is returned. diff --git a/community/samples/serving/helloworld-haskell/index.md b/community/samples/serving/helloworld-haskell/index.md index aabfd2de7..671c637a0 100644 --- a/community/samples/serving/helloworld-haskell/index.md +++ b/community/samples/serving/helloworld-haskell/index.md @@ -12,7 +12,7 @@ specified, it will use "World" as the TARGET. ## Prerequisites - A Kubernetes cluster with Knative installed and DNS configured. Follow the - [installation instructions](../../../../docs/install/README.md) if you need to create + [installation instructions](../../../../docs/install/) if you need to create one. - [Docker](https://www.docker.com) installed and running on your local machine, and a Docker Hub account configured (we'll use it for a container registry). @@ -168,14 +168,14 @@ folder) you're ready to build and deploy the sample app. ``` kubectl get ksvc helloworld-haskell --output=custom-columns=NAME:.metadata.name,URL:.status.url NAME URL - helloworld-haskell http://helloworld-haskell.default.1.2.3.4.xip.io + helloworld-haskell http://helloworld-haskell.default.1.2.3.4.sslip.io ``` 1. Now you can make a request to your app and see the result. Replace the URL below with the URL returned in the previous command. ```shell - curl http://helloworld-haskell.default.1.2.3.4.xip.io + curl http://helloworld-haskell.default.1.2.3.4.sslip.io Hello world: Haskell Sample v1 ``` @@ -186,4 +186,3 @@ To remove the sample app from your cluster, delete the service record: ```shell kubectl delete --filename service.yaml ``` - diff --git a/community/samples/serving/helloworld-java-micronaut/index.md b/community/samples/serving/helloworld-java-micronaut/index.md index b02c18233..a416eb722 100644 --- a/community/samples/serving/helloworld-java-micronaut/index.md +++ b/community/samples/serving/helloworld-java-micronaut/index.md @@ -20,7 +20,7 @@ deploying your app to your Knative cluster. You must meet the following requirements to complete this sample: - A version of the Knative Serving component installed and DNS configured. Follow the - [Knative installation instructions](../../../../docs/install/README.md) if you need + [Knative installation instructions](../../../../docs/install/) if you need to create a Knative cluster. - The following software downloaded and install on your loacal machine: - [Java SE 8 or later JDK](http://www.oracle.com/technetwork/java/javase/downloads/index.html). @@ -261,14 +261,14 @@ To verify that your sample app has been successfully deployed: ```shell NAME URL - helloworld-java-micronaut http://helloworld-java-micronaut.default.1.2.3.4.xip.io + helloworld-java-micronaut http://helloworld-java-micronaut.default.1.2.3.4.sslip.io ``` 1. Now you can make a request to your app and see the result. Replace the URL below with the URL returned in the previous command. ```shell - curl http://helloworld-java-micronaut.default.1.2.3.4.xip.io + curl http://helloworld-java-micronaut.default.1.2.3.4.sslip.io ``` Example result: diff --git a/community/samples/serving/helloworld-java-quarkus/index.md b/community/samples/serving/helloworld-java-quarkus/index.md index 6ea760aec..b4ad8e9b7 100644 --- a/community/samples/serving/helloworld-java-quarkus/index.md +++ b/community/samples/serving/helloworld-java-quarkus/index.md @@ -18,7 +18,7 @@ You must meet the following requirements to run this sample: - Have a Kubernetes cluster running with the Knative Serving component installed. For more information, see the - [Knative instruction guides](https://github.com/knative/docs/blob/main/docs/install/README.md). + [Knative instruction guides](https://github.com/knative/docs/blob/main/docs/install/). - An installed version of the following tools: - [Docker](https://www.docker.com) - [Java SE 8 or later JDK](https://www.eclipse.org/openj9/) @@ -255,14 +255,14 @@ folder) you're ready to build and deploy the sample app. kubectl get ksvc helloworld-java-quarkus NAME URL - helloworld-java-quarkus http://helloworld-java-quarkus.default.1.2.3.4.xip.io + helloworld-java-quarkus http://helloworld-java-quarkus.default.1.2.3.4.sslip.io ``` 1. Now you can make a request to your app and see the result. Replace the URL below with the URL returned in the previous command. ```shell - curl http://helloworld-java-quarkus.default.1.2.3.4.xip.io + curl http://helloworld-java-quarkus.default.1.2.3.4.sslip.io Namaste Knative World! ``` diff --git a/community/samples/serving/helloworld-r/index.md b/community/samples/serving/helloworld-r/index.md index 19230c91a..eddbf2548 100644 --- a/community/samples/serving/helloworld-r/index.md +++ b/community/samples/serving/helloworld-r/index.md @@ -21,7 +21,7 @@ cd knative-docs/docs/serving/samples/hello-world/helloworld-r ## Before you begin - A Kubernetes cluster with Knative installed. Follow the - [installation instructions](../../../../docs/install/README.md) if you need to + [installation instructions](../../../../docs/install/) if you need to create one. - [Docker](https://www.docker.com) installed and running on your local machine, and a Docker Hub account configured (we'll use it for a container registry). @@ -169,20 +169,20 @@ folder) you're ready to build and deploy the sample app. ```shell NAME URL - helloworld-r http://helloworld-r.default.1.2.3.4.xip.io + helloworld-r http://helloworld-r.default.1.2.3.4.sslip.io ``` 1. Now you can make a request to your app and see the result. Replace the URL below with the URL returned in the previous command. ```shell - curl http://helloworld-r.default.1.2.3.4.xip.io + curl http://helloworld-r.default.1.2.3.4.sslip.io ``` Example: ```shell - curl http://helloworld-r.default.1.2.3.4.xip.io + curl http://helloworld-r.default.1.2.3.4.sslip.io [1] "Hello R Sample v1!" ``` @@ -195,4 +195,3 @@ To remove the sample app from your cluster, delete the service record: ```shell kubectl delete --filename service.yaml ``` - diff --git a/community/samples/serving/helloworld-rserver/index.md b/community/samples/serving/helloworld-rserver/index.md index 4c87f2a37..911695767 100644 --- a/community/samples/serving/helloworld-rserver/index.md +++ b/community/samples/serving/helloworld-rserver/index.md @@ -22,7 +22,7 @@ cd knative-docs/docs/serving/samples/hello-world/helloworld-r ## Before you begin - A Kubernetes cluster with Knative installed. Follow the - [installation instructions](../../../../docs/install/README.md) if you need to + [installation instructions](../../../../docs/install/) if you need to create one. - [Docker](https://www.docker.com) installed and running on your local machine, and a Docker Hub account configured (we'll use it for a container registry). @@ -140,20 +140,20 @@ folder) you're ready to build and deploy the sample app. ```shell NAME URL - helloworld-r http://helloworld-r.default.1.2.3.4.xip.io + helloworld-r http://helloworld-r.default.1.2.3.4.sslip.io ``` 1. Now you can make a request to your app and see the result. Replace the URL below with the URL returned in the previous command. ```shell - curl http://helloworld-rserver.default.1.2.3.4.xip.io + curl http://helloworld-rserver.default.1.2.3.4.sslip.io ``` Example: ```shell - curl http://helloworld-rserver.default.1.2.3.4.xip.io + curl http://helloworld-rserver.default.1.2.3.4.sslip.io [1] "Hello R Sample v1!" ``` diff --git a/community/samples/serving/helloworld-rust/index.md b/community/samples/serving/helloworld-rust/index.md index 27dee0f5e..f54a6aef9 100644 --- a/community/samples/serving/helloworld-rust/index.md +++ b/community/samples/serving/helloworld-rust/index.md @@ -13,7 +13,7 @@ TARGET is not specified, it will use "World" as the TARGET. ## Prerequisites - A Kubernetes cluster with Knative installed and DNS configured. Follow the - [installation instructions](../../../../docs/install/README.md) if you need to create + [installation instructions](../../../../docs/install/) if you need to create one. - [Docker](https://www.docker.com) installed and running on your local machine, and a Docker Hub account configured (we'll use it for a container registry). @@ -169,14 +169,14 @@ folder) you're ready to build and deploy the sample app. ```shell kubectl get ksvc helloworld-rust --output=custom-columns=NAME:.metadata.name,URL:.status.url NAME URL - helloworld-rust http://helloworld-rust.default.1.2.3.4.xip.io + helloworld-rust http://helloworld-rust.default.1.2.3.4.sslip.io ``` 1. Now you can make a request to your app and see the result. Replace the URL below with the URL returned in the previous command. ```shell - curl http://helloworld-rust.default.1.2.3.4.xip.io + curl http://helloworld-rust.default.1.2.3.4.sslip.io Hello World! ``` diff --git a/community/samples/serving/helloworld-swift/index.md b/community/samples/serving/helloworld-swift/index.md index 5ea4b7c1d..52baa61cd 100644 --- a/community/samples/serving/helloworld-swift/index.md +++ b/community/samples/serving/helloworld-swift/index.md @@ -13,7 +13,7 @@ specified, the app uses "World" as the TARGET. - You must have a Kubernetes cluster with Knative installed and DNS configured. If you need to create a cluster, follow the - [installation instructions](../../../../docs/install/README.md). + [installation instructions](../../../../docs/install/). - You must have [Docker](https://www.docker.com) installed and running on your local machine, and a Docker Hub account configured (used for container registry). @@ -149,14 +149,14 @@ folder) you're ready to build and deploy the sample app. ``` kubectl get ksvc helloworld-swift --output=custom-columns=NAME:.metadata.name,URL:.status.url NAME URL - helloworld-swift http://helloworld-swift.default.1.2.3.4.xip.io + helloworld-swift http://helloworld-swift.default.1.2.3.4.sslip.io ``` 1. Now you can make a request to your app and see the result. Replace the URL below with the URL returned in the previous command. ```shell - curl http://helloworld-swift.default.1.2.3.4.xip.io + curl http://helloworld-swift.default.1.2.3.4.sslip.io Hello Swift ``` diff --git a/community/samples/serving/helloworld-vertx/index.md b/community/samples/serving/helloworld-vertx/index.md index afe70544f..06b34e979 100644 --- a/community/samples/serving/helloworld-vertx/index.md +++ b/community/samples/serving/helloworld-vertx/index.md @@ -20,7 +20,7 @@ You must meet the following requirements to complete this sample: - A version of the Knative Serving component installed and running on your Kubernetes cluster. Follow the - [Knative installation instructions](../../../../docs/install/README.md) if you need to + [Knative installation instructions](../../../../docs/install/) if you need to create a Knative cluster. - The following software downloaded and install on your loacal machine: - [Java SE 8 or later JDK](http://www.oracle.com/technetwork/java/javase/downloads/index.html). @@ -229,14 +229,14 @@ To verify that your sample app has been successfully deployed: ```shell NAME URL - helloworld-vertx http://helloworld-vertx.default.1.2.3.4.xip.io + helloworld-vertx http://helloworld-vertx.default.1.2.3.4.sslip.io ``` 1. Now you can make a request to your app and see the result. Replace the URL below with the URL returned in the previous command. ```shell - curl http://helloworld-vertx.default.1.2.3.4.xip.io + curl http://helloworld-vertx.default.1.2.3.4.sslip.io ``` Example result: diff --git a/community/samples/serving/machinelearning-python-bentoml/index.md b/community/samples/serving/machinelearning-python-bentoml/index.md index 6c867e0ab..cc7f2a3b8 100644 --- a/community/samples/serving/machinelearning-python-bentoml/index.md +++ b/community/samples/serving/machinelearning-python-bentoml/index.md @@ -21,7 +21,7 @@ Knative deployment guide with BentoML is also available in the ## Before you begin - A Kubernetes cluster with Knative installed. Follow the - [installation instructions](../../../../docs/install/README.md) if you need to + [installation instructions](../../../../docs/install/) if you need to create one. - [Docker](https://www.docker.com) installed and running on your local machine, and a Docker Hub account configured. Docker Hub will be used for a container registry). diff --git a/docs/eventing/accessing-traces.md b/docs/eventing/accessing-traces.md index 6933b8f3d..aad80c15c 100644 --- a/docs/eventing/accessing-traces.md +++ b/docs/eventing/accessing-traces.md @@ -13,7 +13,7 @@ visualize and trace your requests. ## Before you begin -You must have a Knative cluster running with the Eventing component installed. [Learn more](../install/README.md) +You must have a Knative cluster running with the Eventing component installed. [Learn more](../install/) ## Configuring tracing @@ -43,7 +43,7 @@ metadata: name: config-tracing namespace: knative-eventing data: - enable: "true" + backend: "zipkin" zipkin-endpoint: "http://zipkin.istio-system.svc.cluster.local:9411/api/v2/spans" sample-rate: "0.1" ``` diff --git a/docs/eventing/broker/kafka-broker/README.md b/docs/eventing/broker/kafka-broker/README.md index 237df94e9..2d59baa1a 100644 --- a/docs/eventing/broker/kafka-broker/README.md +++ b/docs/eventing/broker/kafka-broker/README.md @@ -321,8 +321,8 @@ spec: The supported consumer delivery guarantees are: -* `unordered`: Unordered consumer is a non-blocking consumer that potentially delivers messages unordered, while preserving proper offset management. -* `ordered`: Ordered consumer is a per-partition blocking consumer that delivers messages in order. +* `unordered`: An unordered consumer is a non-blocking consumer that delivers messages unordered, while preserving proper offset management. +* `ordered`: An ordered consumer is a per-partition blocking consumer that waits for a successful response from the CloudEvent subscriber before it delivers the next message of the partition. `unordered` is the default ordering guarantee, while **`ordered` is considered unstable, use with caution**. diff --git a/docs/eventing/channels/channel-types-defaults.md b/docs/eventing/channels/channel-types-defaults.md index 8e90cf34a..a0966b99c 100644 --- a/docs/eventing/channels/channel-types-defaults.md +++ b/docs/eventing/channels/channel-types-defaults.md @@ -12,7 +12,7 @@ Knative provides the InMemoryChannel channel implementation by default. This def **NOTE:** InMemoryChannel channels should not be used in production environments. The default channel implementation is specified in the `default-ch-webhook` ConfigMap in the `knative-eventing` namespace. -For more information about modifying ConfigMaps, see [Configuring the Eventing Operator custom resource](./docs/install/configuring-eventing-cr/). +For more information about modifying ConfigMaps, see [Configuring the Eventing Operator custom resource](../../../docs/install/operator/configuring-eventing-cr). In the following example, the cluster default channel implementation is InMemoryChannel, while the namespace default channel implementation for the `example-namespace` is KafkaChannel. diff --git a/docs/eventing/debugging/index.md b/docs/eventing/debugging/index.md index e067bf137..9764287ad 100644 --- a/docs/eventing/debugging/index.md +++ b/docs/eventing/debugging/index.md @@ -13,12 +13,12 @@ setup. ## Audience This document is intended for people that are familiar with the object model of -[Knative Eventing](../README.md). You don't need to be an expert, but do need to +[Knative Eventing](../). You don't need to be an expert, but do need to know roughly how things fit together. ## Prerequisites -1. Setup [Knative Eventing and an Eventing-contrib resource](../README.md). +1. Setup [Knative Eventing and an Eventing-contrib resource](../). ## Example diff --git a/docs/eventing/event-registry.md b/docs/eventing/event-registry.md index 26cb20d05..73fd25d81 100644 --- a/docs/eventing/event-registry.md +++ b/docs/eventing/event-registry.md @@ -14,7 +14,7 @@ type information in the cluster data store. ## Before you begin -1. Read about the [broker](./broker/) and [trigger](./triggers/) objects. +1. Read about the [broker](../broker/) and [trigger](../broker/triggers/) objects. 1. Be familiar with the [CloudEvents spec](https://github.com/cloudevents/spec/blob/master/spec.md), particularly the @@ -281,14 +281,9 @@ the next topic: How do we actually populate the registry in the first place? are two topics). You can see that in the registry example output from the previous sections. -## What's next +## Next steps -To get started, install Knative Eventing if you haven't yet, and try -experimenting with different Event Sources in your Knative cluster. - -1. [Installing Knative](../install/README.md) in case you haven't already done - so. -1. [Getting started with eventing](./README.md) in case you haven't read it. +1. [Installing Knative](../install/). 1. [Knative code samples](./samples/) is a useful resource to better understand some of the Event Sources (remember to point them to a Broker if you want automatic registration of EventTypes in the registry). diff --git a/docs/eventing/flows/parallel.md b/docs/eventing/flows/parallel.md index 52c574a93..76ca1ddae 100644 --- a/docs/eventing/flows/parallel.md +++ b/docs/eventing/flows/parallel.md @@ -46,4 +46,4 @@ Parallel has three parts for the Status: ## Examples -Learn how to use Parallel by following the [examples](../samples/parallel/README.md) +Learn how to use Parallel by following the [examples](../samples/parallel/) diff --git a/docs/eventing/getting-started.md b/docs/eventing/getting-started.md index e911d0832..7cc4ae863 100644 --- a/docs/eventing/getting-started.md +++ b/docs/eventing/getting-started.md @@ -26,7 +26,7 @@ kubectl create namespace event-example ## Adding a broker to the namespace -The [broker](./broker/README.md#broker) allows you to route events to different event sinks or consumers. +The [broker](./broker) allows you to route events to different event sinks or consumers. 1. Add a broker named `default` to your namespace by entering the following command: @@ -54,7 +54,7 @@ The [broker](./broker/README.md#broker) allows you to route events to different ``` If `READY` is `False`, wait a few moments and then run the command again. - If you continue to receive the `False` status, see the [Debugging Guide](./debugging/README.md) to troubleshoot the issue. + If you continue to receive the `False` status, see the [Debugging Guide](./debugging/) to troubleshoot the issue. ## Creating event consumers @@ -150,11 +150,11 @@ demonstrate how you can configure your event producers to target a specific cons goodbye-display 1/1 1 1 16s ``` The number of replicas in the **READY** column should match the number of replicas in the **AVAILABLE** column. - If the numbers do not match, see the [Debugging Guide](./debugging/README.md) to troubleshoot the issue. + If the numbers do not match, see the [Debugging Guide](./debugging/) to troubleshoot the issue. ## Creating triggers -A [trigger](./broker/README.md#trigger) defines the events that each event consumer receives. +A [trigger](./broker/triggers) defines the events that each event consumer receives. Brokers use triggers to forward events to the correct consumers. Each trigger can specify a filter that enables selection of relevant events based on the Cloud Event context attributes. @@ -218,7 +218,7 @@ Each trigger can specify a filter that enables selection of relevant events base The `SUBSCRIBER_URI` has a value similar to `triggerName.namespaceName.svc.cluster.local`. The exact value depends on the broker implementation. - If this value looks incorrect, see the [Debugging Guide](./debugging/README.md) to troubleshoot the issue. + If this value looks incorrect, see the [Debugging Guide](./debugging/) to troubleshoot the issue. ## Creating a pod as an event producer diff --git a/docs/eventing/samples/README.md b/docs/eventing/samples/README.md index c495f0576..2b2d7c9b1 100644 --- a/docs/eventing/samples/README.md +++ b/docs/eventing/samples/README.md @@ -10,6 +10,6 @@ showlandingtoc: "true" Use the following code samples to help you understand the various use cases for Knative Eventing and Event Sources. -[Learn more about Knative Eventing and Eventing Sources](../README.md). +[Learn more about Knative Eventing and Eventing Sources](../). [**See all Knative code samples**](../../samples.md) diff --git a/docs/eventing/samples/helloworld/README.md b/docs/eventing/samples/helloworld/README.md index 277674518..62016076d 100644 --- a/docs/eventing/samples/helloworld/README.md +++ b/docs/eventing/samples/helloworld/README.md @@ -15,13 +15,13 @@ We will deploy the app as a [Kubernetes Deployment](https://kubernetes.io/docs/concepts/workloads/controllers/deployment/) along with a [Kubernetes Service](https://kubernetes.io/docs/concepts/services-networking/service/). -However, you can also deploy the app as a [Knative Serving Service](../../../serving/README.md) +However, you can also deploy the app as a [Knative Serving Service](../../../serving/) ## Prerequisites - A Kubernetes cluster with [Knative Eventing](../../getting-started.md#installing-knative-eventing) installed. - If you decide to deploy the app as a Knative Serving Service then you will have to install - [Knative Serving](../../../install/README.md). + [Knative Serving](../../../install/). - [Docker](https://www.docker.com) installed and running on your local machine, and a Docker Hub account configured (we'll use it for a container registry). diff --git a/docs/eventing/samples/helloworld/helloworld-go/README.md b/docs/eventing/samples/helloworld/helloworld-go/README.md index d4d955006..59edebc09 100644 --- a/docs/eventing/samples/helloworld/helloworld-go/README.md +++ b/docs/eventing/samples/helloworld/helloworld-go/README.md @@ -18,7 +18,7 @@ We will deploy the app as a along with a [Kubernetes Service](https://kubernetes.io/docs/concepts/services-networking/service/). However, you can also deploy the app as a -[Knative Serving Service](../../../../serving/README.md). +[Knative Serving Service](../../../../serving/). Follow the steps below to create the sample code and then deploy the app to your cluster. You can also download a working copy of the sample, by running the @@ -282,7 +282,7 @@ application and trigger are ready, let's send a CloudEvent. ### Send CloudEvent to the Broker -We can send an http request directly to the [Broker](../../../broker/README.md) +We can send an http request directly to the [Broker](../../../broker/) with correct CloudEvent headers set. 1. Deploy a curl pod and SSH into it diff --git a/docs/eventing/samples/helloworld/helloworld-python/README.md b/docs/eventing/samples/helloworld/helloworld-python/README.md index 603000514..3b6f0f914 100644 --- a/docs/eventing/samples/helloworld/helloworld-python/README.md +++ b/docs/eventing/samples/helloworld/helloworld-python/README.md @@ -10,7 +10,7 @@ type: "docs" A simple web app written in Python that you can use to test knative eventing. It shows how to consume a [CloudEvent](https://cloudevents.io/) in Knative eventing, and optionally how to respond back with another CloudEvent in the http response, by adding the Cloud Eventing headers outlined in the Cloud Events standard definition. We will deploy the app as a [Kubernetes Deployment](https://kubernetes.io/docs/concepts/workloads/controllers/deployment/) along with a [Kubernetes Service](https://kubernetes.io/docs/concepts/services-networking/service/). -However, you can also deploy the app as a [Knative Serving Service](../../../../serving/README.md). +However, you can also deploy the app as a [Knative Serving Service](../../../../serving/). Follow the steps below to create the sample code and then deploy the app to your cluster. You can also download a working copy of the sample, by running the diff --git a/docs/eventing/samples/kafka/README.md b/docs/eventing/samples/kafka/README.md index 02cd6bd3a..a1038c0de 100644 --- a/docs/eventing/samples/kafka/README.md +++ b/docs/eventing/samples/kafka/README.md @@ -99,6 +99,6 @@ $ ./kafka_setup.sh A number of different examples, showing the `KafkaSource`, `KafkaChannel` and `KafkaBinding` can be found here: -- [`KafkaSource` to `Service`](./source/README.md) -- [`KafkaChannel` and Broker](./channel/README.md) -- [`KafkaBinding`](./binding/README.md) +- [`KafkaSource` to `Service`](./source/) +- [`KafkaChannel` and Broker](./channel/) +- [`KafkaBinding`](./binding/) diff --git a/docs/eventing/samples/kafka/binding/index.md b/docs/eventing/samples/kafka/binding/index.md index e9fa705bf..c461931f3 100644 --- a/docs/eventing/samples/kafka/binding/index.md +++ b/docs/eventing/samples/kafka/binding/index.md @@ -20,7 +20,7 @@ via Kafka Source ### Prerequisites 1. You must ensure that you meet the - [prerequisites listed in the Apache Kafka overview](../README.md). + [prerequisites listed in the Apache Kafka overview](../). 2. This feature is available from Knative Eventing 0.15+ ### Creating a `KafkaSource` source CRD diff --git a/docs/eventing/samples/kafka/channel/README.md b/docs/eventing/samples/kafka/channel/README.md index 60e2dc68d..bd0bbdf24 100644 --- a/docs/eventing/samples/kafka/channel/README.md +++ b/docs/eventing/samples/kafka/channel/README.md @@ -13,9 +13,9 @@ default channel configuration in Knative Eventing. ## Prerequisites - Ensure that you meet the - [prerequisites listed in the Apache Kafka overview](../README.md). + [prerequisites listed in the Apache Kafka overview](../). - A Kubernetes cluster with - [Knative Kafka Channel installed](../../../../install/README.md). + [Knative Kafka Channel installed](../../../../install/). ## Creating a `KafkaChannel` channel CRD diff --git a/docs/eventing/samples/parallel/README.md b/docs/eventing/samples/parallel/README.md index 3bcc502e7..056195f2c 100644 --- a/docs/eventing/samples/parallel/README.md +++ b/docs/eventing/samples/parallel/README.md @@ -19,7 +19,7 @@ All examples require: - Knative Serving All examples are using the -[default channel template](../../channels/default-channels.md). +[default channel template](../../channels/create-default-channel.md). ## Examples @@ -32,5 +32,5 @@ trivial filtering, transformation and routing of the incoming events. The examples are: -- [Parallel with multiple branches and global reply](./multiple-branches/README.md) -- [Parallel with mutually exclusive cases](./mutual-exclusivity/README.md) +- [Parallel with multiple branches and global reply](./multiple-branches/) +- [Parallel with mutually exclusive cases](./mutual-exclusivity/) diff --git a/docs/eventing/samples/parallel/multiple-branches/README.md b/docs/eventing/samples/parallel/multiple-branches/README.md index e857c2f7c..60df45b37 100644 --- a/docs/eventing/samples/parallel/multiple-branches/README.md +++ b/docs/eventing/samples/parallel/multiple-branches/README.md @@ -16,7 +16,7 @@ The events produced by each branch are then sent to the `event-display` service. ## Prerequisites -Please refer to the sample overview for the [prerequisites](../README.md). +Please refer to the sample overview for the [prerequisites](../). ### Create the Knative Services diff --git a/docs/eventing/samples/parallel/mutual-exclusivity/README.md b/docs/eventing/samples/parallel/mutual-exclusivity/README.md index d17719b3b..947b85a2d 100644 --- a/docs/eventing/samples/parallel/mutual-exclusivity/README.md +++ b/docs/eventing/samples/parallel/mutual-exclusivity/README.md @@ -11,7 +11,7 @@ In this example, we are going to see how we can create a Parallel with mutually exclusive branches. This example is the same as the -[multiple branches example](../multiple-branches/README.md) except that we are +[multiple branches example](../multiple-branches/) except that we are now going to rely on the Knative [switch](https://github.com/lionelvillard/knative-functions#switch) function to provide a soft mutual exclusivity guarantee. @@ -20,7 +20,7 @@ NOTE: this example must be deployed in the default namespace. ## Prerequisites -Please refer to the sample overview for the [prerequisites](../README.md). +Please refer to the sample overview for the [prerequisites](../). ### Create the Knative Services diff --git a/docs/eventing/sources/container-source/README.md b/docs/eventing/sources/container-source/README.md index af96236b4..5ca33cdf7 100644 --- a/docs/eventing/sources/container-source/README.md +++ b/docs/eventing/sources/container-source/README.md @@ -71,7 +71,7 @@ The status of the created service can be seen using: kubectl get ksvc NAME URL LATESTCREATED LATESTREADY READY REASON -event-display http://event-display.default.1.2.3.4.xip.io event-display-gqjbw event-display-gqjbw True +event-display http://event-display.default.1.2.3.4.sslip.io event-display-gqjbw event-display-gqjbw True ``` ### Create a ContainerSource using the heartbeats image diff --git a/docs/eventing/sources/gitlab-source/README.md b/docs/eventing/sources/gitlab-source/README.md index d1d8361d8..4fd88aab8 100644 --- a/docs/eventing/sources/gitlab-source/README.md +++ b/docs/eventing/sources/gitlab-source/README.md @@ -17,7 +17,7 @@ Knative Service. You will need: 1. An internet-accessible Kubernetes cluster with Knative Serving installed. - Follow the [installation instructions](../../../install/README.md) if you + Follow the [installation instructions](../../../install/) if you need to create one. 1. Ensure Knative Serving is [configured with a domain name](../../../serving/using-a-custom-domain.md) diff --git a/docs/eventing/sources/kafka-source/README.md b/docs/eventing/sources/kafka-source/README.md index bc96ad555..6fcbe7d6f 100644 --- a/docs/eventing/sources/kafka-source/README.md +++ b/docs/eventing/sources/kafka-source/README.md @@ -9,10 +9,16 @@ type: "docs" Tutorial on how to build and deploy a `KafkaSource` [Eventing source](../../../sources/README.md) using a Knative Serving `Service`. +## Background + +The `KafkaSource` reads all the messages, from all partitions, and sends those messages as CloudEvents via HTTP to its configured `sink`. + +*NOTE:* In case you need a more sophisticated Kafka Consumer, with direct access to specific partitions or offsets you might want to implement a _Kafka Consumer_, using one of the available Apache Kafka SDKs, to handle the messages yourself, rather than using the Knative `KafkaSource`. + ## Prerequisites -- Ensure that you meet the [prerequisites listed in the Apache Kafka overview](../README.md). -- A Kubernetes cluster with [Knative Kafka Source installed](../../../../install/README.md). +- Ensure that you meet the [prerequisites listed in the Apache Kafka overview](../). +- A Kubernetes cluster with [Knative Kafka Source installed](../../../../install/). ## Apache Kafka Topic (Optional) diff --git a/docs/getting-started/contributing/contributing.md b/docs/getting-started/contributing/contributing.md new file mode 100644 index 000000000..59ec83cf7 --- /dev/null +++ b/docs/getting-started/contributing/contributing.md @@ -0,0 +1,236 @@ +# MkDocs Contributions (Beta) +**This is a temporary home for contribution guidelines for the MkDocs branch. When MkDocs becomes "main" this will be moved to the appropriate place on the website** + + +## Install Material for MkDocs +Knative.dev uses [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/) to render documentation. Material for MkDocs is Python based and uses pip to install most of it's required packages as well as optional add-ons (which we use). + +You can choose to install MkDocs locally or using a Docker image. pip actually comes pre-installed with Python so it is included in many operating systems (like MacOSx or Ubuntu) but if you don’t have Python, you can install it here: https://www.python.org + +For some (e.g. folks using RHEL), you may have to use pip3. + + +=== "pip" + ``` + pip install mkdocs-material + ``` + More detailed instructions can be found here: [https://squidfunk.github.io/mkdocs-material/getting-started/#installation](https://squidfunk.github.io/mkdocs-material/getting-started/#installation) + +=== "pip3" + ``` + pip3 install mkdocs-material + ``` + More detailed instructions can be found here: [https://squidfunk.github.io/mkdocs-material/getting-started/#installation](https://squidfunk.github.io/mkdocs-material/getting-started/#installation) + +## Install Knative-Specific Extensions + +Knative uses a number of extensions to MkDocs which can also be installed using pip. If you used pip to install, run the following: + +=== "pip" + ``` + pip install mkdocs-material-extensions mkdocs-macros-plugin mkdocs-exclude mkdocs-awesome-pages-plugin + ``` + +=== "pip3" + ``` + pip3 install mkdocs-material-extensions mkdocs-macros-plugin mkdocs-exclude mkdocs-awesome-pages-plugin + ``` + +## Use the Docker Container +//TODO DOCKER CONTAINER EXTENSIONS + +## Setting Up Local Preview +Once you have installed Material for MkDocs and all of the extensions, head over to +--8<-- "docs/snippets/links/main-docs-branch-link.md" +and clone the repo. + +In your terminal, find your way over to the location of the cloned repo. Once you are in the main folder (.../docs) and run: + +=== "Local Preview" + ``` + mkdocs serve + ``` + +=== "Local Preview w/ Dirty Reload" + If you’re only changing a single page in the /docs/ folder (i.e. not the homepage or mkdocs.yml) adding the flag --dirtyreload will make the site rebuild super crazy insta-fast. + ``` + mkdocs serve --dirtyreload + ``` +=== "Local Preview including Blog and Community Site" + First, install the necessary extensions: + ``` + npm install -g postcss postcss-cli autoprefixer http-server + ``` + Once you have those npm packages installed, run: + ``` + ./hack/build-with-blog.sh serve + ``` + !!! note + Unfortunately, there aren’t live previews for this version of the local preview. + + + +After awhile, your terminal should spit out: + +```{ .bash .no-copy } +INFO - Documentation built in 13.54 seconds +[I 210519 10:47:10 server:335] Serving on http://127.0.0.1:8000 +[I 210519 10:47:10 handlers:62] Start watching changes +[I 210519 10:47:10 handlers:64] Start detecting changes +``` + +Now access http://127.0.0.1:8000 and you should see the site is built! 🎉 + +**Anytime you change any file in your /docs/ repo and hit save, the site will automatically rebuild itself to reflect your changes!** + +## Setting Up "Public" Preview +If, for whatever reason, you want to share your work before submitting a PR (where Netlify would generate a preview for you), you can deploy your changes as a Github Page easily using the following command: +``` +mkdocs gh-deploy --force +``` + +```{ .bash .no-copy } +INFO - Documentation built in 14.29 seconds +WARNING - Version check skipped: No version specified in previous deployment. +INFO - Copying '/Users/omerbensaadon/Documents/GitHub/MergeConflictsResolve/docs/site' to 'gh-pages' branch and pushing to GitHub. +INFO - Your documentation should shortly be available at: https://.github.io/docs/ +``` +Where `` is your Github handle. + +After a few moments, your changes should be available for public preview at the link provided by MkDocs! This means you can rapidly prototype and share your changes before making a PR! + +## Navigation +Navigation in MkDocs uses the "mkdocs.yml" file (found in the /docs directory) to organize navigation. + +=== "Frontend" + ![nav-frontend](images/nav-frontend.png) + +=== "Backend" + ![nav-backend](images/nav-backend.png) + +For more in-depth information on Navigation, see: +[https://www.mkdocs.org/user-guide/writing-your-docs/#configure-pages-and-navigation](https://www.mkdocs.org/user-guide/writing-your-docs/#configure-pages-and-navigation) +and +[https://squidfunk.github.io/mkdocs-material/setup/setting-up-navigation/](https://squidfunk.github.io/mkdocs-material/setup/setting-up-navigation/) + +### Content Tabs +Content tabs are handy way to organize lots of information in a visually pleasing way. Some documentation from [https://squidfunk.github.io/mkdocs-material/reference/content-tabs/#usage](https://squidfunk.github.io/mkdocs-material/reference/content-tabs/#usage) is reproduced below. +=== "Grouping Code blocks" + Code blocks are one of the primary targets to be grouped, and can be considered a special case of content tabs, as tabs with a single code block are always rendered without horizontal spacing. + Example: + ``` + === "C" + + ``` c + #include + + int main(void) { + printf("Hello world!\n"); + return 0; + } + ``` + + === "C++" + + ``` c++ + #include + + int main(void) { + std::cout << "Hello world!" << std::endl; + return 0; + } + ``` + ``` + + Result: + === "C" + + ``` c + #include + + int main(void) { + printf("Hello world!\n"); + return 0; + } + ``` + + === "C++" + + ``` c++ + #include + + int main(void) { + std::cout << "Hello world!" << std::endl; + return 0; + } + ``` + +=== "Grouping other content" + When a content tab contains more than one code block, it is rendered with horizontal spacing. Vertical spacing is never added, but can be achieved by nesting tabs in other blocks. + + Example: + + ``` + === "Unordered list" + + * Sed sagittis eleifend rutrum + * Donec vitae suscipit est + * Nulla tempor lobortis orci + + === "Ordered list" + + 1. Sed sagittis eleifend rutrum + 2. Donec vitae suscipit est + 3. Nulla tempor lobortis orci + ``` + + Result: + === "Unordered list" + + * Sed sagittis eleifend rutrum + * Donec vitae suscipit est + * Nulla tempor lobortis orci + + === "Ordered list" + + 1. Sed sagittis eleifend rutrum + 2. Donec vitae suscipit est + 3. Nulla tempor lobortis orci + +For more information, see:[https://squidfunk.github.io/mkdocs-material/reference/content-tabs/#usage](https://squidfunk.github.io/mkdocs-material/reference/content-tabs/#usage) +### File Includes (Content Reuse) +Knative strives to reduce duplicative effort by reusing commonly used bits of information, see the docs/snippet directory for some examples. + +Snippets does not require a specific extension, and as long as a valid file name is specified, it will attempt to process it. + +Snippets can handle recursive file inclusion. And if Snippets encounters the same file in the current stack, it will avoid re-processing it in order to avoid an infinite loop (or crash on hitting max recursion depth). + +For more info, see: [https://facelessuser.github.io/pymdown-extensions/extensions/snippets/](https://facelessuser.github.io/pymdown-extensions/extensions/snippets/) + +### Admonitions +=== "Admontion" + !!! tip + Admonitions (like this one) are a great way to highlight important bits of information for readers. + +=== "Formating" + ``` + !!! tip + Admonitions (like this one) are a great way to highlight important bits of information for readers. + ``` +For formatting (including more advanced Admonitions), see: [https://squidfunk.github.io/mkdocs-material/reference/admonitions/#usage](https://squidfunk.github.io/mkdocs-material/reference/admonitions/#usage) + + +### Icons and Emojis +Material for MkDocs supports using Material Icons and Emojis using easy shortcodes. +=== "Emojs" + :taco: +=== "Formatting" + `:taco:` + +To search a database of Icons and Emojis (all of which can be used on Knative.dev), as well as usage information, see: [https://squidfunk.github.io/mkdocs-material/reference/icons-emojis/#search](https://squidfunk.github.io/mkdocs-material/reference/icons-emojis/#search) + +# TODO (Add Requests Here) +URL Re-directs +Navigation using lukasgeiter/mkdocs-awesome-pages-plugin: An MkDocs plugin that simplifies configuring page titles and their order +Index.md vs. README.md +awesome-pages diff --git a/docs/getting-started/contributing/images/nav-backend.png b/docs/getting-started/contributing/images/nav-backend.png new file mode 100644 index 000000000..180b67ae3 Binary files /dev/null and b/docs/getting-started/contributing/images/nav-backend.png differ diff --git a/docs/getting-started/contributing/images/nav-frontend.png b/docs/getting-started/contributing/images/nav-frontend.png new file mode 100644 index 000000000..b5a721fb8 Binary files /dev/null and b/docs/getting-started/contributing/images/nav-frontend.png differ diff --git a/docs/install/installation-files.md b/docs/install/installation-files.md index 1be1b8357..f8a87c80c 100644 --- a/docs/install/installation-files.md +++ b/docs/install/installation-files.md @@ -25,7 +25,7 @@ The table below describes the installation files in the Knative Serving release: | --- | --- | --- | | serving-core.yaml | Required: Knative Serving core components. | serving-crds.yaml | | serving-crds.yaml | Required: Knative Serving core CRDs. | none | -| serving-default-domain.yaml | Configures Knative Serving to use [http://xip.io](http://xip.io) as the default DNS suffix. | serving-core.yaml | +| serving-default-domain.yaml | Configures Knative Serving to use [http://sslip.io](http://sslip.io) as the default DNS suffix. | serving-core.yaml | | serving-domainmapping-crds.yaml | CRDs used by the Domain Mapping feature. | none | | serving-domainmapping.yaml | Components used by the Domain Mapping feature. | serving-domainmapping-crds.yaml | | serving-hpa.yaml | Components to autoscale Knative revisions through the Kubernetes Horizontal Pod Autoscaler. | serving-core.yaml | diff --git a/docs/install/installing-istio.md b/docs/install/installing-istio.md index c89204455..3084e83b7 100644 --- a/docs/install/installing-istio.md +++ b/docs/install/installing-istio.md @@ -199,7 +199,7 @@ istio-pilot ClusterIP 10.0.3.27 15010/TCP,150 ``` This external IP can be used with your DNS provider with a wildcard `A` record. However, for a basic non-production set -up, this external IP address can be used with `xip.io` in the `config-domain` ConfigMap in `knative-serving`. +up, this external IP address can be used with `sslip.io` in the `config-domain` ConfigMap in `knative-serving`. You can edit this by using the following command: @@ -216,9 +216,9 @@ metadata: name: config-domain namespace: knative-serving data: - # xip.io is a "magic" DNS provider, which resolves all DNS lookups for: - # *.{ip}.xip.io to {ip}. - 34.83.80.117.xip.io: "" + # sslip.io is a "magic" DNS provider, which resolves all DNS lookups for: + # *.{ip}.sslip.io to {ip}. + 34.83.80.117.sslip.io: "" ``` ## Istio resources @@ -236,10 +236,7 @@ See the [Uninstall Istio](https://istio.io/docs/setup/install/istioctl/#uninstal ## What's next -- [Install Knative](./README.md). -- Try the - [Getting Started with App Deployment guide](../serving/getting-started-knative-app.md) - for Knative serving. +- Try the [Getting Started with App Deployment guide](../serving/getting-started-knative-app) for Knative serving. [1]: https://istio.io/docs/setup/kubernetes/additional-setup/sidecar-injection/#manual-sidecar-injection diff --git a/docs/samples.md b/docs/samples.md index 2f33809c0..4afadae58 100755 --- a/docs/samples.md +++ b/docs/samples.md @@ -18,11 +18,11 @@ closer with your goals. View the set of Knative code samples that are actively tested and maintained: - [Eventing and Eventing Sources code samples](./eventing/samples/) -- [Serving code samples](./serving/samples/README.md) +- [Serving code samples](./serving/samples/) ### Community owned and maintained -[View code samples that are contributed and maintained by the community](../community/samples/README.md). +[View code samples that are contributed and maintained by the community](../community/samples/). ### External code samples @@ -31,7 +31,7 @@ A list of links to Knative code samples that live outside of - [Image processing using Knative Eventing, Cloud Run on GKE (Knative Serving implementation) and Google Cloud Vision API](https://github.com/akashrv/knative-samples/blob/master/docs/image-processing.md) - [A potpourri of Knative Eventing Examples](https://github.com/lionelvillard/knative-examples) -- [Knfun - a complete Knative example of three functions using Twitter and Watson API that use kn to deploy and manage functions](https://github.com/maximilien/knfun/blob/master/README.md) +- [Knfun - a complete Knative example of three functions using Twitter and Watson API that use kn to deploy and manage functions](https://github.com/maximilien/knfun/blob/master/) - [Knative Eventing (Cloud Events) example using spring-boot and spring-cloud-streams + Kafka](https://salaboy.com/2020/02/20/getting-started-with-knative-2020/) - [Image processing pipeline using Knative Eventing on GKE, Google Cloud Vision API and ImageSharp library](https://github.com/meteatamel/knative-tutorial/blob/master/docs/image-processing-pipeline.md) - [BigQuery processing pipeline using Knative Eventing on GKE, Cloud Scheduler, BigQuery, mathplotlib and SendGrid](https://github.com/meteatamel/knative-tutorial/blob/master/docs/bigquery-processing-pipeline.md) diff --git a/docs/serving/README.md b/docs/serving/README.md index 2be40a428..0e8fd8969 100644 --- a/docs/serving/README.md +++ b/docs/serving/README.md @@ -11,12 +11,12 @@ Knative Serving builds on Kubernetes and Istio to support deploying and serving of serverless applications and functions. Serving is easy to get started with and scales to support advanced scenarios. -The Knative Serving project provides middleware primitives that enable: +The Knative Serving project provides middleware components that enable: -- Rapid deployment of serverless containers -- [Automatic scaling up and down to zero](./autoscaling/) -- Routing and network programming for Istio components -- Point-in-time snapshots of deployed code and configurations +- Rapid deployment of serverless containers. +- Autoscaling including scaling pods down to zero. +- Support for multiple networking layers such as Ambassador, Courier, Gloo, Istio, and Kong, for integration into existing environments. +- Point-in-time snapshots of deployed code and configurations. ## Serving resources @@ -24,22 +24,22 @@ Knative Serving defines a set of objects as Kubernetes Custom Resource Definitions (CRDs). These objects are used to define and control how your serverless workload behaves on the cluster: -- [Service](https://github.com/knative/docs/blob/main/docs/serving/spec/knative-api-specification-1.0.md#service): +- [Service](https://github.com/knative/specs/blob/main/specs/serving/knative-api-specification-1.0.md#service): The `service.serving.knative.dev` resource automatically manages the whole lifecycle of your workload. It controls the creation of other objects to ensure that your app has a route, a configuration, and a new revision for each update of the service. Service can be defined to always route traffic to the latest revision or to a pinned revision. -- [Route](https://github.com/knative/docs/blob/main/docs/serving/spec/knative-api-specification-1.0.md#route): +- [Route](https://github.com/knative/specs/blob/main/specs/serving/knative-api-specification-1.0.md#route): The `route.serving.knative.dev` resource maps a network endpoint to one or more revisions. You can manage the traffic in several ways, including fractional traffic and named routes. -- [Configuration](https://github.com/knative/docs/blob/main/docs/serving/spec/knative-api-specification-1.0.md#configuration): +- [Configuration](https://github.com/knative/specs/blob/main/specs/serving/knative-api-specification-1.0.md#configuration): The `configuration.serving.knative.dev` resource maintains the desired state for your deployment. It provides a clean separation between code and configuration and follows the Twelve-Factor App methodology. Modifying a configuration creates a new revision. -- [Revision](https://github.com/knative/docs/blob/main/docs/serving/spec/knative-api-specification-1.0.md#revision): +- [Revision](https://github.com/knative/specs/blob/main/specs/serving/knative-api-specification-1.0.md#revision): The `revision.serving.knative.dev` resource is a point-in-time snapshot of the code and configuration for each modification made to the workload. Revisions are immutable objects and can be retained for as long as useful. Knative @@ -60,28 +60,26 @@ With the `Service` resource, a deployed service will automatically have a matching route and configuration created. Each time the `Service` is updated, a new revision is created. -For more information on the resources and their interactions, see the -[Resource Types Overview](https://github.com/knative/serving/blob/main/docs/spec/overview.md) -in the Knative Serving repository. +For more information on the resources and their interactions, see the [Resource Types Overview](https://github.com/knative/specs/blob/main/specs/serving/overview.md) in the Knative Serving repository. ## More samples and demos -- [Knative Serving code samples](./samples/README.md) +- [Knative Serving code samples](./samples/) ## Debugging Knative Serving issues -- [Debugging Application Issues](./debugging-application-issues.md) +- [Debugging Application Issues](./debugging-application-issues) ## Configuration and Networking -- [Configuring cluster local routes](./cluster-local-route.md) -- [Using a custom domain](./using-a-custom-domain.md) -- [Assigning a static IP address for Knative on Google Kubernetes Engine](./gke-assigning-static-ip-address.md) -- [Using subroutes](./using-subroutes.md) +- [Configuring cluster local routes](./cluster-local-route) +- [Using a custom domain](./using-a-custom-domain) +- [Assigning a static IP address for Knative on Google Kubernetes Engine](./gke-assigning-static-ip-address) +- [Using subroutes](./using-subroutes) ## Observability -- [Serving Metrics API](./metrics.md) +- [Serving Metrics API](./metrics) ## Known Issues diff --git a/docs/serving/autoscaling/README.md b/docs/serving/autoscaling/README.md index 96e051250..04571fda8 100644 --- a/docs/serving/autoscaling/README.md +++ b/docs/serving/autoscaling/README.md @@ -16,16 +16,16 @@ The Autoscaler component watches traffic flow to the application, and scales rep Knative services default to using autoscaling settings that are suitable for the majority of use cases. However, some workloads may require a custom, more finely-tuned configuration. This guide provides information about configuration options that you can modify to fit the requirements of your workload. -For more information about how autoscaling for Knative works, see the [Autoscaling concepts](./autoscaling-concepts.md) documentation. +For more information about how autoscaling for Knative works, see the [Autoscaling concepts](./autoscaling-concepts) documentation. -For more information about which metrics can be used to control the Autoscaler, see the [metrics](./autoscaling-metrics.md) documentation. +For more information about which metrics can be used to control the Autoscaler, see the [metrics](./autoscaling-metrics) documentation. ## Optional autoscaling configuration tasks * Configure your Knative deployment to use the Kubernetes Horizontal Pod Autoscaler (HPA) instead of the default KPA. -For how to install HPA, see [Install optional Eventing extensions](../../install/install-extensions.md#install-optional-serving-extensions). -* Disable scale to zero functionality for your cluster ([global configuration only](./scale-to-zero.md)). -* Configure the [type of metrics](./autoscaling-metrics.md) your Autoscaler consumes. -* Configure [concurrency limits](./concurrency.md) for applications. -* Try out the [Go Autoscale Sample App](./autoscale-go/README.md). +For how to install HPA, see [Install optional Eventing extensions](../../install/install-extensions#install-optional-serving-extensions). +* Disable scale to zero functionality for your cluster ([global configuration only](./scale-to-zero)). +* Configure the [type of metrics](./autoscaling-metrics) your Autoscaler consumes. +* Configure [concurrency limits](./concurrency) for applications. +* Try out the [Go Autoscale Sample App](./autoscale-go/). diff --git a/docs/serving/autoscaling/autoscale-go/index.md b/docs/serving/autoscaling/autoscale-go/index.md index d88bb318f..b315fcf0f 100644 --- a/docs/serving/autoscaling/autoscale-go/index.md +++ b/docs/serving/autoscaling/autoscale-go/index.md @@ -13,7 +13,7 @@ A demonstration of the autoscaling capabilities of a Knative Serving Revision. ## Prerequisites -1. A Kubernetes cluster with [Knative Serving](../../../install/README.md) +1. A Kubernetes cluster with [Knative Serving](../../../install/) installed. 1. The `hey` load generator installed (`go get -u github.com/rakyll/hey`). 1. Clone this repository, and move into the sample directory: @@ -36,7 +36,7 @@ A demonstration of the autoscaling capabilities of a Knative Serving Revision. ``` $ kubectl get ksvc autoscale-go NAME URL LATESTCREATED LATESTREADY READY REASON - autoscale-go http://autoscale-go.default.1.2.3.4.xip.io autoscale-go-96dtk autoscale-go-96dtk True + autoscale-go http://autoscale-go.default.1.2.3.4.sslip.io autoscale-go-96dtk autoscale-go-96dtk True ``` ## Load the Service @@ -44,7 +44,7 @@ A demonstration of the autoscaling capabilities of a Knative Serving Revision. 1. Make a request to the autoscale app to see it consume some resources. ```shell - curl "http://autoscale-go.default.1.2.3.4.xip.io?sleep=100&prime=10000&bloat=5" + curl "http://autoscale-go.default.1.2.3.4.sslip.io?sleep=100&prime=10000&bloat=5" ``` ``` @@ -57,7 +57,7 @@ A demonstration of the autoscaling capabilities of a Knative Serving Revision. ```shell hey -z 30s -c 50 \ - "http://autoscale-go.default.1.2.3.4.xip.io?sleep=100&prime=10000&bloat=5" \ + "http://autoscale-go.default.1.2.3.4.sslip.io?sleep=100&prime=10000&bloat=5" \ && kubectl get pods ``` @@ -222,21 +222,21 @@ customization (32 minutes). ```shell hey -z 60s -c 100 \ - "http://autoscale-go.default.1.2.3.4.xip.io?sleep=100&prime=10000&bloat=5" + "http://autoscale-go.default.1.2.3.4.sslip.io?sleep=100&prime=10000&bloat=5" ``` 1. Send 60 seconds of traffic maintaining 100 qps with short requests (10 ms). ```shell hey -z 60s -q 100 \ - "http://autoscale-go.default.1.2.3.4.xip.io?sleep=10" + "http://autoscale-go.default.1.2.3.4.sslip.io?sleep=10" ``` 1. Send 60 seconds of traffic maintaining 100 qps with long requests (1 sec). ```shell hey -z 60s -q 100 \ - "http://autoscale-go.default.1.2.3.4.xip.io?sleep=1000" + "http://autoscale-go.default.1.2.3.4.sslip.io?sleep=1000" ``` 1. Send 60 seconds of traffic with heavy CPU usage (~1 cpu/sec/request, total @@ -244,7 +244,7 @@ customization (32 minutes). ```shell hey -z 60s -q 100 \ - "http://autoscale-go.default.1.2.3.4.xip.io?prime=40000000" + "http://autoscale-go.default.1.2.3.4.sslip.io?prime=40000000" ``` 1. Send 60 seconds of traffic with heavy memory usage (1 gb/request, total 5 @@ -252,7 +252,7 @@ customization (32 minutes). ```shell hey -z 60s -c 5 \ - "http://autoscale-go.default.1.2.3.4.xip.io?bloat=1000" + "http://autoscale-go.default.1.2.3.4.sslip.io?bloat=1000" ``` ## Cleanup diff --git a/docs/serving/debugging-application-issues.md b/docs/serving/debugging-application-issues.md index 2482ccad0..d5c844f8d 100644 --- a/docs/serving/debugging-application-issues.md +++ b/docs/serving/debugging-application-issues.md @@ -40,7 +40,7 @@ kubectl get route --output yaml The `conditions` in `status` provide the reason if there is any failure. For details, see Knative -[Error Conditions and Reporting](https://github.com/knative/docs/blob/main/docs/serving/spec/knative-api-specification-1.0.md#error-signalling). +[Error Conditions and Reporting](https://github.com/knative/specs/blob/main/specs/serving/knative-api-specification-1.0.md#error-signalling). ### Check Ingress/Istio routing diff --git a/docs/serving/deploying-from-private-registry/README.md b/docs/serving/deploying-from-private-registry/README.md index a2b0efacf..3bac6d54c 100644 --- a/docs/serving/deploying-from-private-registry/README.md +++ b/docs/serving/deploying-from-private-registry/README.md @@ -7,10 +7,10 @@ type: "docs" # Deploying images from a private container registry -Learn how to configure your Knative cluster to deploy images from a private +Learn how to configure your Knative cluster to deploy images from a private container registry. -To share access to your private container images across multiple services and +To share access to your private container images across multiple services and revisions, you create a list of Kubernetes secrets ([`imagePullSecrets`](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#pod-v1-core)) using your registry credentials, add that `imagePullSecrets` to your default @@ -21,7 +21,7 @@ and then deploy those configurations to your Knative cluster. You need: -- A Kubernetes cluster with [Knative Serving installed](../../install/README.md). +- A Kubernetes cluster with [Knative Serving installed](../../install/). - The credentials to the private container registry where your container images are stored. ## Configuring your credentials in Knative @@ -41,7 +41,7 @@ You need: (`imagePullSecrets` object). For example, `container-registry`. - `[PRIVATE_REGISTRY_SERVER_URL]` is the URL to the private - registry where your container images are stored. + registry where your container images are stored. Examples: - Google Container Registry: [https://gcr.io/](https://gcr.io/) @@ -55,9 +55,9 @@ You need: * `[PRIVATE_REGISTRY_PASSWORD]` is the password that you use to access the private container registry. - + Example: - + ```shell kubectl create secret `container-registry` \ --docker-server=https://gcr.io/ \ @@ -65,20 +65,19 @@ You need: --docker-username=my-grc-username \ --docker-password=my-gcr-password ``` - + Tip: After creating the `imagePullSecrets`, you can view those secret's by running: - + ```shell kubectl get secret [REGISTRY-CRED-SECRETS] --output=yaml ``` 1. Add the `imagePullSecrets` to your `default` service account in the `default` namespace. - - Note: By default, the `default` service account in each of the - [namespaces](https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/) - of your Knative cluster are use by your revisions unless - [`serviceAccountName`](../spec/knative-api-specification-1.0.md) is specified. + + Note: By default, the `default` service account in each of the + [namespaces](https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/) + of your Knative cluster are use by your revisions unless [`serviceAccountName`](https://github.com/knative/specs/blob/main/specs/serving/knative-api-specification-1.0.md#revision-2) is specified. Run the following command to modify your `default` service account, assuming you named your secrets `container-registry`: @@ -92,5 +91,4 @@ your credentials and have access to your container images in the private registr ## What's next -You can now create a service that uses your container images from the private registry. -[Learn how to create a Knative service](../getting-started-knative-app.md). +[Learn how to create a Knative service](../getting-started-knative-app). diff --git a/docs/serving/feature-flags.md b/docs/serving/feature-flags.md index 162f20bf0..97147b8c5 100644 --- a/docs/serving/feature-flags.md +++ b/docs/serving/feature-flags.md @@ -275,17 +275,8 @@ spec: ... ``` -## Responsive Revision Garbage Collector -* **Type**: extension -* **ConfigMap key:** `responsive-revision-gc` - -This flag controls whether new responsive garbage collection is enabled. This -feature labels revisions in real-time as they become referenced and -dereferenced by Routes. This allows us to reap revisions shortly after -they are no longer active. - ## Tag Header Based Routing * **Type**: extension * **ConfigMap key:** `tag-header-based-routing` -This flags controls whether [tag header based routing](./samples/tag-header-based-routing/README.md) is enabled. +This flags controls whether [tag header based routing](./samples/tag-header-based-routing/) is enabled. diff --git a/docs/serving/getting-started-knative-app.md b/docs/serving/getting-started-knative-app.md index 20e4eb12e..48d0a2cbc 100644 --- a/docs/serving/getting-started-knative-app.md +++ b/docs/serving/getting-started-knative-app.md @@ -16,7 +16,7 @@ using cURL requests. You need: -- A Kubernetes cluster with [Knative Serving installed](../install/README.md). +- A Kubernetes cluster with [Knative Serving installed](../install/). - An image of the app that you'd like to deploy available on a container registry. The image of the sample app used in this guide is available on Google Container Registry. @@ -35,7 +35,7 @@ To deploy a local container image, you need to disable image tag resolution by r docker tag local-image dev.local/local-image ``` -[Learn more about image tag resolution.](./tag-resolution.md) +[Learn more about image tag resolution.](./tag-resolution) The Hello World sample app reads in an `env` variable, `TARGET`, then prints "Hello World: \${TARGET}!". If `TARGET` isn't defined, it will print "NOT SPECIFIED". @@ -43,7 +43,7 @@ The Hello World sample app reads in an `env` variable, `TARGET`, then prints "He The easiest way to deploy a Knative Service is by using the Knative CLI [kn](https://github.com/knative/client). -**Prerequisite:** Install the `kn` binary as described in [Installing the Knative CLI](../install/install-kn.md) +**Prerequisite:** Install the `kn` binary as described in [Installing the Knative CLI](../install/install-kn) It will create a corresponding resource description internally as when using a YAML file directly. `kn` provides a command-line mechanism for managing Services. @@ -71,12 +71,12 @@ Now that you have deployed the service, Knative will perform the following steps ## Creating your Deployment with YAML Alternatively, to deploy an app using Knative, you can also create the configuration in a YAML file that defines a service. For more information about the Service object, see the -[Resource Types documentation](https://github.com/knative/serving/blob/main/docs/spec/overview.md#service). +[Resource Types documentation](https://github.com/knative/serving/blob/main/docs/spec/overview#service). This configuration file specifies metadata about the application, points to the hosted image of the app for deployment, and allows the deployment to be configured. For more information about what configuration options are available, -see the [Serving spec documentation](https://github.com/knative/serving/blob/main/docs/spec/spec.md). +see the [Serving spec documentation](https://github.com/knative/serving/blob/main/docs/spec/spec). To create the same application as in the previous `kn` example, create a new file named `service.yaml`, then copy and paste the following content into it: @@ -120,7 +120,7 @@ To see if your app has been deployed successfully, you need the URL created by K 1. To find the URL for your service, use either `kn` or `kubectl` - + === "kn" ```shell @@ -133,7 +133,7 @@ To see if your app has been deployed successfully, you need the URL created by K Name helloworld-go Namespace default Age 12m - URL http://helloworld-go.default.34.83.80.117.xip.io + URL http://helloworld-go.default.34.83.80.117.sslip.io Revisions: 100% @latest (helloworld-go-dyqsj-1) [1] (39s) @@ -157,7 +157,7 @@ To see if your app has been deployed successfully, you need the URL created by K ```shell NAME URL LATESTCREATED LATESTREADY READY REASON - helloworld-go http://helloworld-go.default.34.83.80.117.xip.io helloworld-go-96dtk helloworld-go-96dtk True + helloworld-go http://helloworld-go.default.34.83.80.117.sslip.io helloworld-go-96dtk helloworld-go-96dtk True ``` @@ -165,7 +165,7 @@ To see if your app has been deployed successfully, you need the URL created by K > Note: If your URL includes `example.com` then consult the setup instructions for - > configuring DNS (e.g. with `xip.io`), or [using a Custom Domain](../serving/using-a-custom-domain.md). + > configuring DNS (e.g. with `sslip.io`), or [using a Custom Domain](../serving/using-a-custom-domain). If you changed the name from `helloworld-go` to something else when creating the `.yaml` file, replace `helloworld-go` in the above commands with the name you entered. @@ -174,7 +174,7 @@ To see if your app has been deployed successfully, you need the URL created by K the URL with the one returned by the command in the previous step. ```shell - # curl http://helloworld-go.default.34.83.80.117.xip.io + # curl http://helloworld-go.default.34.83.80.117.sslip.io Hello World: Go Sample v1! ``` diff --git a/docs/serving/samples/README.md b/docs/serving/samples/README.md index e4d72c87d..b78bb5d61 100644 --- a/docs/serving/samples/README.md +++ b/docs/serving/samples/README.md @@ -9,20 +9,19 @@ type: "docs" Use the following code samples to help you understand the various Knative Serving resources and how they can be applied across common use cases. -[Learn more about Knative Serving resources](../README.md). -[**See all Knative code samples**](../../samples.md) +[**See all Knative code samples**](../../samples) | Name | Description | Languages | | ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | -| Hello World | A quick introduction that highlights how to deploy an app using Knative Serving. | [C#](./hello-world/helloworld-csharp/README.md), [Go](./hello-world/helloworld-go/README.md), [Java (Spark)](./hello-world/helloworld-java-spark/README.md), [Java (Spring)](./hello-world/helloworld-java-spring/README.md), [Kotlin](./hello-world/helloworld-kotlin/README.md), [Node.js](./hello-world/helloworld-nodejs/README.md), [PHP](./hello-world/helloworld-php/README.md), [Python](./hello-world/helloworld-python/README.md), [Ruby](./hello-world/helloworld-ruby/README.md), [Scala](./hello-world/helloworld-scala/README.md), [Shell](./hello-world/helloworld-shell/README.md) | -| Cloud Events | A quick introduction that highlights how to send and receive Cloud Events. | [C#](./cloudevents/cloudevents-dotnet/README.md), [Go](./cloudevents/cloudevents-go/README.md), [Node.js](./cloudevents/cloudevents-nodejs/README.md), [Rust](./cloudevents/cloudevents-rust/README.md), [Java (Vert.x)](./cloudevents/cloudevents-vertx/README.md) | -| Advanced Deployment | Simple blue/green-like application deployment pattern illustrating the process of updating a live application without dropping any traffic. | [YAML](./blue-green-deployment.md) | -| Autoscale | A demonstration of the autoscaling capabilities of Knative. | [Go](../autoscaling/autoscale-go/README.md) | -| Github Webhook | A simple webhook handler that demonstrates interacting with Github. | [Go](./gitwebhook-go/README.md) | -| gRPC | A simple gRPC server. | [Go](./grpc-ping-go/README.md) | -| Knative Routing | An example of mapping multiple Knative services to different paths under a single domain name using the Istio VirtualService concept. | [Go](./knative-routing-go/README.md) | -| Knative Secrets | A simple app that demonstrates how to use a Kubernetes secret as a Volume in Knative. | [Go](./secrets-go/README.md) | -| REST API | A simple Restful service that exposes an endpoint defined by an environment variable described in the Knative Configuration. | [Go](./rest-api-go/README.md) | -| Traffic Splitting | This samples builds off the [Creating a RESTful Service](./rest-api-go) sample to illustrate applying a revision, then using that revision for manual traffic splitting. | [YAML](./traffic-splitting/README.md) | -| Multi Container | A quick introduction that highlights how to build and deploy an app using Knative Serving for multiple containers. | [Go](./multi-container/README.md) | +| Hello World | A quick introduction that highlights how to deploy an app using Knative Serving. | [C#](./hello-world/helloworld-csharp/), [Go](./hello-world/helloworld-go/), [Java (Spark)](./hello-world/helloworld-java-spark/), [Java (Spring)](./hello-world/helloworld-java-spring/), [Kotlin](./hello-world/helloworld-kotlin/), [Node.js](./hello-world/helloworld-nodejs/), [PHP](./hello-world/helloworld-php/), [Python](./hello-world/helloworld-python/), [Ruby](./hello-world/helloworld-ruby/), [Scala](./hello-world/helloworld-scala/), [Shell](./hello-world/helloworld-shell/) | +| Cloud Events | A quick introduction that highlights how to send and receive Cloud Events. | [C#](./cloudevents/cloudevents-dotnet/), [Go](./cloudevents/cloudevents-go/), [Node.js](./cloudevents/cloudevents-nodejs/), [Rust](./cloudevents/cloudevents-rust/), [Java (Vert.x)](./cloudevents/cloudevents-vertx/) | +| Advanced Deployment | Simple blue/green-like application deployment pattern illustrating the process of updating a live application without dropping any traffic. | [YAML](./blue-green-deployment) | +| Autoscale | A demonstration of the autoscaling capabilities of Knative. | [Go](../autoscaling/autoscale-go/) | +| Github Webhook | A simple webhook handler that demonstrates interacting with Github. | [Go](./gitwebhook-go/) | +| gRPC | A simple gRPC server. | [Go](./grpc-ping-go/) | +| Knative Routing | An example of mapping multiple Knative services to different paths under a single domain name using the Istio VirtualService concept. | [Go](./knative-routing-go/) | +| Knative Secrets | A simple app that demonstrates how to use a Kubernetes secret as a Volume in Knative. | [Go](./secrets-go/) | +| REST API | A simple Restful service that exposes an endpoint defined by an environment variable described in the Knative Configuration. | [Go](./rest-api-go/) | +| Traffic Splitting | This samples builds off the [Creating a RESTful Service](./rest-api-go) sample to illustrate applying a revision, then using that revision for manual traffic splitting. | [YAML](./traffic-splitting/) | +| Multi Container | A quick introduction that highlights how to build and deploy an app using Knative Serving for multiple containers. | [Go](./multi-container/) | diff --git a/docs/serving/samples/blue-green-deployment.md b/docs/serving/samples/blue-green-deployment.md index f02e69bad..77c9ba721 100644 --- a/docs/serving/samples/blue-green-deployment.md +++ b/docs/serving/samples/blue-green-deployment.md @@ -16,7 +16,7 @@ configuration. You need: -- A Kubernetes cluster with [Knative installed](../../install/README.md). +- A Kubernetes cluster with [Knative installed](../../install/). - (Optional) [A custom domain configured](../using-a-custom-domain.md) for use with Knative. diff --git a/docs/serving/samples/cloudevents/cloudevents-dotnet/index.md b/docs/serving/samples/cloudevents/cloudevents-dotnet/index.md index e61d775d0..14f87f14f 100644 --- a/docs/serving/samples/cloudevents/cloudevents-dotnet/index.md +++ b/docs/serving/samples/cloudevents/cloudevents-dotnet/index.md @@ -34,7 +34,7 @@ cd knative-docs/docs/serving/samples/cloudevents/cloudevents-dotnet ## Before you begin - A Kubernetes cluster with Knative installed and DNS configured. Follow the - [installation instructions](../../../../install/README.md) if you need to + [installation instructions](../../../../install/) if you need to create one. - [Docker](https://www.docker.com) installed and running on your local machine, and a Docker Hub account configured (we'll use it for a container registry). diff --git a/docs/serving/samples/cloudevents/cloudevents-go/index.md b/docs/serving/samples/cloudevents/cloudevents-go/index.md index 1729502a0..121395518 100644 --- a/docs/serving/samples/cloudevents/cloudevents-go/index.md +++ b/docs/serving/samples/cloudevents/cloudevents-go/index.md @@ -34,7 +34,7 @@ cd knative-docs/docs/serving/samples/cloudevents/cloudevents-go ## Before you begin - A Kubernetes cluster with Knative installed and DNS configured. Follow the - [installation instructions](../../../../install/README.md) if you need to + [installation instructions](../../../../install/) if you need to create one. - [Docker](https://www.docker.com) installed and running on your local machine, and a Docker Hub account configured (we'll use it for a container registry). @@ -136,7 +136,7 @@ Get the URL for your Service with: ```shell $ kubectl get ksvc NAME URL LATESTCREATED LATESTREADY READY REASON -cloudevents-go http://cloudevents-go.default.1.2.3.4.xip.io cloudevents-go-ss5pj cloudevents-go-ss5pj True +cloudevents-go http://cloudevents-go.default.1.2.3.4.sslip.io cloudevents-go-ss5pj cloudevents-go-ss5pj True ``` Then send a cloud event to it with: @@ -149,7 +149,7 @@ $ curl -X POST \ -H "ce-type: curl.demo" \ -H "ce-id: 123-abc" \ -d '{"name":"Dave"}' \ - http://cloudevents-go.default.1.2.3.4.xip.io + http://cloudevents-go.default.1.2.3.4.sslip.io ``` You will get back: diff --git a/docs/serving/samples/cloudevents/cloudevents-nodejs/index.md b/docs/serving/samples/cloudevents/cloudevents-nodejs/index.md index 7855d5313..cb3c034f9 100644 --- a/docs/serving/samples/cloudevents/cloudevents-nodejs/index.md +++ b/docs/serving/samples/cloudevents/cloudevents-nodejs/index.md @@ -34,7 +34,7 @@ cd knative-docs/docs/serving/samples/cloudevents/cloudevents-nodejs ## Before you begin - A Kubernetes cluster with Knative installed and DNS configured. Follow the - [installation instructions](../../../../install/README.md) if you need to + [installation instructions](../../../../install/) if you need to create one. - [Docker](https://www.docker.com) installed and running on your local machine, and a Docker Hub account configured (we'll use it for a container registry). @@ -93,7 +93,7 @@ Get the URL for your Service with: ```shell $ kubectl get ksvc NAME URL LATESTCREATED LATESTREADY READY REASON -cloudevents-nodejs http://cloudevents-nodejs.default.1.2.3.4.xip.io cloudevents-nodejs-ss5pj cloudevents-nodejs-ss5pj True +cloudevents-nodejs http://cloudevents-nodejs.default.1.2.3.4.sslip.io cloudevents-nodejs-ss5pj cloudevents-nodejs-ss5pj True ``` Then send a cloud event to it with: @@ -106,7 +106,7 @@ $ curl -X POST \ -H "ce-type: curl.demo" \ -H "ce-id: 123-abc" \ -d '{"name":"Dave"}' \ - http://cloudevents-nodejs.default.1.2.3.4.xip.io + http://cloudevents-nodejs.default.1.2.3.4.sslip.io ``` You will get back: diff --git a/docs/serving/samples/cloudevents/cloudevents-rust/index.md b/docs/serving/samples/cloudevents/cloudevents-rust/index.md index 06496d562..978826945 100644 --- a/docs/serving/samples/cloudevents/cloudevents-rust/index.md +++ b/docs/serving/samples/cloudevents/cloudevents-rust/index.md @@ -36,7 +36,7 @@ cd knative-docs/docs/serving/samples/cloudevents/cloudevents-rust ## Before you begin - A Kubernetes cluster with Knative installed and DNS configured. Follow the - [installation instructions](../../../../install/README.md) if you need to + [installation instructions](../../../../install/) if you need to create one. - [Docker](https://www.docker.com) installed and running on your local machine, and a Docker Hub account configured (we'll use it for a container registry). @@ -87,7 +87,7 @@ Get the URL for your Service with: ```shell $ kubectl get ksvc NAME URL LATESTCREATED LATESTREADY READY REASON -cloudevents-rust http://cloudevents-rust.xip.io cloudevents-rust-vl8fq cloudevents-rust-vl8fq True +cloudevents-rust http://cloudevents-rust.sslip.io cloudevents-rust-vl8fq cloudevents-rust-vl8fq True ``` Then send a CloudEvent to it with: @@ -101,7 +101,7 @@ $ curl \ -H "ce-type: curl.demo" \ -H "ce-id: 123-abc" \ -d '{"name":"Dave"}' \ - http://cloudevents-rust.xip.io + http://cloudevents-rust.sslip.io ``` You can also send CloudEvents spawning a temporary curl pod in your cluster with: diff --git a/docs/serving/samples/cloudevents/cloudevents-spring/index.md b/docs/serving/samples/cloudevents/cloudevents-spring/index.md index e0727c428..8eced7ec6 100644 --- a/docs/serving/samples/cloudevents/cloudevents-spring/index.md +++ b/docs/serving/samples/cloudevents/cloudevents-spring/index.md @@ -36,7 +36,7 @@ cd knative-docs/docs/serving/samples/cloudevents/cloudevents-spring ## Before you begin - A Kubernetes cluster with Knative installed and DNS configured. Follow the - [installation instructions](../../../../install/README.md) if you need to + [installation instructions](../../../../install/) if you need to create one. - [Docker](https://www.docker.com) installed and running on your local machine, and a Docker Hub account configured (we'll use it for a container registry). @@ -63,7 +63,7 @@ Get the URL for your Service with: ```shell $ kubectl get ksvc NAME URL LATESTCREATED LATESTREADY READY REASON -cloudevents-spring http://cloudevents-java.xip.io cloudevents-spring-86h28 cloudevents-spring-86h28 True +cloudevents-spring http://cloudevents-java.sslip.io cloudevents-spring-86h28 cloudevents-spring-86h28 True ``` Then send a CloudEvent to it with: @@ -77,7 +77,7 @@ $ curl \ -H "ce-type: curl.demo" \ -H "ce-id: 123-abc" \ -d '{"name":"Dave"}' \ - http://cloudevents-java.xip.io + http://cloudevents-java.sslip.io ``` You can also send CloudEvents spawning a temporary curl pod in your cluster diff --git a/docs/serving/samples/cloudevents/cloudevents-vertx/index.md b/docs/serving/samples/cloudevents/cloudevents-vertx/index.md index 1485de1a6..92d906bcd 100644 --- a/docs/serving/samples/cloudevents/cloudevents-vertx/index.md +++ b/docs/serving/samples/cloudevents/cloudevents-vertx/index.md @@ -36,7 +36,7 @@ cd knative-docs/docs/serving/samples/cloudevents/cloudevents-vertx ## Before you begin - A Kubernetes cluster with Knative installed and DNS configured. Follow the - [installation instructions](../../../../install/README.md) if you need to + [installation instructions](../../../../install/) if you need to create one. - [Docker](https://www.docker.com) installed and running on your local machine, and a Docker Hub account configured (we'll use it for a container registry). @@ -78,7 +78,7 @@ Get the URL for your Service with: ```shell $ kubectl get ksvc NAME URL LATESTCREATED LATESTREADY READY REASON -cloudevents-vertx http://cloudevents-java.xip.io cloudevents-vertx-86h28 cloudevents-vertx-86h28 True +cloudevents-vertx http://cloudevents-java.sslip.io cloudevents-vertx-86h28 cloudevents-vertx-86h28 True ``` Then send a CloudEvent to it with: @@ -92,7 +92,7 @@ $ curl \ -H "ce-type: curl.demo" \ -H "ce-id: 123-abc" \ -d '{"name":"Dave"}' \ - http://cloudevents-java.xip.io + http://cloudevents-java.sslip.io ``` You can also send CloudEvents spawning a temporary curl pod in your cluster @@ -157,7 +157,3 @@ To remove the sample app from your cluster, delete the service: ```shell kn service delete cloudevents-vertx ``` - - - - diff --git a/docs/serving/samples/gitwebhook-go/index.md b/docs/serving/samples/gitwebhook-go/index.md index 41da61ff5..d3ca8e41a 100644 --- a/docs/serving/samples/gitwebhook-go/index.md +++ b/docs/serving/samples/gitwebhook-go/index.md @@ -18,7 +18,7 @@ You must meet the following requirements to run this sample: [Google Domains](https://domains.google/). - A Kubernetes cluster running with the following: - Knative Serving must be installed. For details about setting up a Knative - cluster, see the [installation guides](../../../install/README.md). + cluster, see the [installation guides](../../../install/). - Your Knative cluster must be [configured to use your custom domain](../../using-a-custom-domain.md). - You must ensure that your Knative cluster uses a static IP address: diff --git a/docs/serving/samples/grpc-ping-go/index.md b/docs/serving/samples/grpc-ping-go/index.md index 886fe4ff7..3ffbb0f6e 100644 --- a/docs/serving/samples/grpc-ping-go/index.md +++ b/docs/serving/samples/grpc-ping-go/index.md @@ -18,7 +18,7 @@ for production containers. ## Prerequisites -- [Install the latest version of Knative Serving](../../../install/README.md). +- [Install the latest version of Knative Serving](../../../install/). - Install [docker](https://www.docker.com/). @@ -110,7 +110,7 @@ Replace `{username}` with your Docker Hub user name and run the command: ```shell docker run --rm {username}/grpc-ping-go \ /client \ - -server_addr="grpc-ping.default.1.2.3.4.xip.io:80" \ + -server_addr="grpc-ping.default.1.2.3.4.sslip.io:80" \ -insecure ``` diff --git a/docs/serving/samples/hello-world/helloworld-csharp/index.md b/docs/serving/samples/hello-world/helloworld-csharp/index.md index 342cba86b..f689077ee 100644 --- a/docs/serving/samples/hello-world/helloworld-csharp/index.md +++ b/docs/serving/samples/hello-world/helloworld-csharp/index.md @@ -23,7 +23,7 @@ cd knative-docs/docs/serving/samples/hello-world/helloworld-csharp ## Before you begin - A Kubernetes cluster with Knative installed and DNS configured. Follow the - [installation instructions](../../../../install/README.md) if you need to + [installation instructions](../../../../install/) if you need to create one. - [Docker](https://www.docker.com) installed and running on your local machine, and a Docker Hub account configured (we'll use it for a container registry). @@ -85,7 +85,7 @@ cd knative-docs/docs/serving/samples/hello-world/helloworld-csharp # Use Microsoft's official build .NET image. FROM mcr.microsoft.com/dotnet/core/sdk:3.1 AS build WORKDIR /app - + # Install production dependencies. # Copy csproj and restore as distinct layers. COPY *.csproj ./ @@ -175,14 +175,14 @@ folder) you're ready to build and deploy the sample app. ``` kubectl get ksvc helloworld-csharp --output=custom-columns=NAME:.metadata.name,URL:.status.url NAME URL - helloworld-csharp http://helloworld-csharp.default.1.2.3.4.xip.io + helloworld-csharp http://helloworld-csharp.default.1.2.3.4.sslip.io ``` 1. Now you can make a request to your app and see the result. Replace the URL below with the URL returned in the previous command. ```shell - curl http://helloworld-csharp.default.1.2.3.4.xip.io + curl http://helloworld-csharp.default.1.2.3.4.sslip.io Hello C# Sample v1! ``` diff --git a/docs/serving/samples/hello-world/helloworld-go/index.md b/docs/serving/samples/hello-world/helloworld-go/index.md index 39b2248b8..4402d5de2 100644 --- a/docs/serving/samples/hello-world/helloworld-go/index.md +++ b/docs/serving/samples/hello-world/helloworld-go/index.md @@ -15,7 +15,7 @@ If `TARGET` is not specified, `World` is used as the default value. ## Prerequisites You will need: -- A Kubernetes cluster with [Knative installed and DNS configured](../../../../install/README.md). +- A Kubernetes cluster with [Knative installed and DNS configured](../../../../install/). - [Docker](https://www.docker.com) installed and running on your local machine, and a Docker Hub account configured. - Optional: You can use the Knative CLI client [`kn`](https://github.com/knative/client/releases) to simplify resource creation and deployment. Alternatively, you can use `kubectl` to apply resource files directly. @@ -124,7 +124,7 @@ You will need: can deploy the app into your cluster. Choose one of the following methods: - + === "yaml" 1. Create a new file, `service.yaml` and copy the following service definition @@ -214,7 +214,7 @@ You will need: the URL below with the URL returned in the previous command. ```shell - curl http://helloworld-go.default.1.2.3.4.xip.io + curl http://helloworld-go.default.1.2.3.4.sslip.io Hello Go Sample v1! ``` @@ -234,6 +234,3 @@ To remove the sample app from your cluster, delete the service record: ```shell kn service delete helloworld-go ``` - - - diff --git a/docs/serving/samples/hello-world/helloworld-java-spark/index.md b/docs/serving/samples/hello-world/helloworld-java-spark/index.md index 4f083dfcc..b822a4233 100644 --- a/docs/serving/samples/hello-world/helloworld-java-spark/index.md +++ b/docs/serving/samples/hello-world/helloworld-java-spark/index.md @@ -14,7 +14,7 @@ This guide describes the steps required to to create the `helloworld-java` sampl ## Prerequisites You will need: -- A Kubernetes cluster with [Knative installed and DNS configured](../../../../install/README.md). +- A Kubernetes cluster with [Knative installed and DNS configured](../../../../install/). - [Docker](https://www.docker.com) installed and running on your local machine, and a Docker Hub account configured. - [Java SE 8 or later JDK](http://www.oracle.com/technetwork/java/javase/downloads/index.html). @@ -80,7 +80,7 @@ cd knative-docs/docs/serving/samples/hello-world/helloworld-java 1. After the build has completed and the container is pushed to Docker Hub, you can deploy the app into your cluster. Choose one of the following methods: - + === "kn" Use `kn` to deploy the service, make sure to replace `{username}` with your Docker Hub username: @@ -135,7 +135,7 @@ cd knative-docs/docs/serving/samples/hello-world/helloworld-java 1. Run one of the followings commands to find the domain URL for your service. - + === "kn" ```shell @@ -170,7 +170,7 @@ cd knative-docs/docs/serving/samples/hello-world/helloworld-java Example: ```shell - curl http://helloworld-java.default.1.2.3.4.xip.io + curl http://helloworld-java.default.1.2.3.4.sslip.io Hello SparkJava Sample v1! # Even easier with kn: curl $(kn service describe helloworld-java -o url) @@ -192,6 +192,3 @@ To remove the sample app from your cluster, delete the service record. ```shell kubectl delete --filename service.yaml ``` - - - diff --git a/docs/serving/samples/hello-world/helloworld-java-spring/README.md b/docs/serving/samples/hello-world/helloworld-java-spring/README.md index e3e39e2ce..baaf0b4cb 100644 --- a/docs/serving/samples/hello-world/helloworld-java-spring/README.md +++ b/docs/serving/samples/hello-world/helloworld-java-spring/README.md @@ -14,7 +14,7 @@ cd knative-docs/docs/serving/samples/hello-world/helloworld-java-spring ## Before you begin - A Kubernetes cluster with Knative installed and DNS configured. Follow the - [installation instructions](../../../../install/README.md) if you need to + [installation instructions](../../../../install/) if you need to create one. - [Docker](https://www.docker.com) installed and running on your local machine, and a Docker Hub account configured (we'll use it for a container registry). @@ -174,14 +174,14 @@ folder) you're ready to build and deploy the sample app. --output=custom-columns=NAME:.metadata.name,URL:.status.url NAME URL - helloworld-java-spring http://helloworld-java-spring.default.1.2.3.4.xip.io + helloworld-java-spring http://helloworld-java-spring.default.1.2.3.4.sslip.io ``` 1. Now you can make a request to your app and see the result. Replace the URL below with the URL returned in the previous command. ```shell - curl http://helloworld-java-spring.default.1.2.3.4.xip.io + curl http://helloworld-java-spring.default.1.2.3.4.sslip.io Hello Spring Boot Sample v1! ``` diff --git a/docs/serving/samples/hello-world/helloworld-java-spring/index.md b/docs/serving/samples/hello-world/helloworld-java-spring/index.md index 78f90a959..401fd7922 100644 --- a/docs/serving/samples/hello-world/helloworld-java-spring/index.md +++ b/docs/serving/samples/hello-world/helloworld-java-spring/index.md @@ -21,7 +21,7 @@ cd knative-docs/docs/serving/samples/hello-world/helloworld-java-spring ## Prerequisites - A Kubernetes cluster with Knative installed and DNS configured. Follow the - [installation instructions](../../../../install/README.md). + [installation instructions](../../../../install/). - [Docker](https://www.docker.com) installed and running on your local machine, and a Docker Hub account configured. - (optional) The Knative CLI client [kn](https://github.com/knative/client/releases) can be used to simplify the deployment. Alternatively, you can use `kubectl`, and apply resource files directly. @@ -225,7 +225,7 @@ After the build has completed and the container is pushed to Docker Hub, you can Example: ```shell - curl http://helloworld-java-spring.default.1.2.3.4.xip.io + curl http://helloworld-java-spring.default.1.2.3.4.sslip.io Hello Java Spring Sample v1! # Even easier with kn: diff --git a/docs/serving/samples/hello-world/helloworld-kotlin/index.md b/docs/serving/samples/hello-world/helloworld-kotlin/index.md index 7015579a5..43be0d0d7 100644 --- a/docs/serving/samples/hello-world/helloworld-kotlin/index.md +++ b/docs/serving/samples/hello-world/helloworld-kotlin/index.md @@ -23,7 +23,7 @@ cd knative-docs/docs/serving/samples/hello-world/helloworld-kotlin ## Before you begin - A Kubernetes cluster with Knative installed and DNS configured. Follow the - [installation instructions](../../../../install/README.md) if you need to + [installation instructions](../../../../install/) if you need to create one. - [Docker](https://www.docker.com) installed and running on your local machine, and a Docker Hub account configured (we'll use it for a container registry). @@ -180,14 +180,14 @@ folder) you're ready to build and deploy the sample app. kubectl get ksvc helloworld-kotlin --output=custom-columns=NAME:.metadata.name,URL:.status.url NAME URL - helloworld-kotlin http://helloworld-kotlin.default.1.2.3.4.xip.io + helloworld-kotlin http://helloworld-kotlin.default.1.2.3.4.sslip.io ``` 1. Now you can make a request to your app and see the result. Replace the URL below with the URL returned in the previous command. ```shell - curl http://helloworld-kotlin.default.1.2.3.4.xip.io + curl http://helloworld-kotlin.default.1.2.3.4.sslip.io Hello Kotlin Sample v1! ``` diff --git a/docs/serving/samples/hello-world/helloworld-nodejs/index.md b/docs/serving/samples/hello-world/helloworld-nodejs/index.md index 905ea187f..6af0a4f21 100644 --- a/docs/serving/samples/hello-world/helloworld-nodejs/index.md +++ b/docs/serving/samples/hello-world/helloworld-nodejs/index.md @@ -23,7 +23,7 @@ cd knative-docs/docs/serving/samples/hello-world/helloworld-nodejs ## Before you begin - A Kubernetes cluster with Knative installed and DNS configured. Follow the - [installation instructions](../../../../install/README.md) if you need to + [installation instructions](../../../../install/) if you need to create one. - [Docker](https://www.docker.com) installed and running on your local machine, and a Docker Hub account configured (we'll use it for a container registry). @@ -187,14 +187,14 @@ folder) you're ready to build and deploy the sample app. ``` kubectl get ksvc helloworld-nodejs --output=custom-columns=NAME:.metadata.name,URL:.status.url NAME URL - helloworld-nodejs http://helloworld-nodejs.default.1.2.3.4.xip.io + helloworld-nodejs http://helloworld-nodejs.default.1.2.3.4.sslip.io ``` 1. Now you can make a request to your app and see the result. Replace the URL below with the URL returned in the previous command. ```shell - curl http://helloworld-nodejs.default.1.2.3.4.xip.io + curl http://helloworld-nodejs.default.1.2.3.4.sslip.io Hello Node.js Sample v1! ``` diff --git a/docs/serving/samples/hello-world/helloworld-php/index.md b/docs/serving/samples/hello-world/helloworld-php/index.md index 95a838903..a85743a21 100644 --- a/docs/serving/samples/hello-world/helloworld-php/index.md +++ b/docs/serving/samples/hello-world/helloworld-php/index.md @@ -23,7 +23,7 @@ cd knative-docs/docs/serving/samples/hello-world/helloworld-php ## Before you begin - A Kubernetes cluster with Knative installed and DNS configured. Follow the - [installation instructions](../../../../install/README.md) if you need to + [installation instructions](../../../../install/) if you need to create one. - [Docker](https://www.docker.com) installed and running on your local machine, and a Docker Hub account configured (we'll use it for a container registry). @@ -193,7 +193,7 @@ folder) you're ready to build and deploy the sample app. the URL below with the URL returned in the previous command. ```shell - curl http://helloworld-php.default.1.2.3.4.xip.io + curl http://helloworld-php.default.1.2.3.4.sslip.io Hello PHP Sample v1! ``` @@ -212,6 +212,3 @@ To remove the sample app from your cluster, delete the service record. ```shell kn service delete helloworld-php ``` - - - diff --git a/docs/serving/samples/hello-world/helloworld-python/index.md b/docs/serving/samples/hello-world/helloworld-python/index.md index c67d03a58..73d00b358 100644 --- a/docs/serving/samples/hello-world/helloworld-python/index.md +++ b/docs/serving/samples/hello-world/helloworld-python/index.md @@ -25,7 +25,7 @@ cd knative-docs/docs/serving/samples/hello-world/helloworld-python ## Prerequisites - A Kubernetes cluster with Knative installed and DNS configured. Follow the - [installation instructions](../../../../install/README.md). + [installation instructions](../../../../install/). - [Docker](https://www.docker.com) installed and running on your local machine, and a Docker Hub account configured. - (optional) The Knative CLI client @@ -175,7 +175,7 @@ cd knative-docs/docs/serving/samples/hello-world/helloworld-python 1. Run one of the followings commands to find the domain URL for your service. > Note: If your URL includes `example.com` then consult the setup instructions for - > configuring DNS (e.g. with `xip.io`), or [using a Custom Domain](../serving/using-a-custom-domain.md). + > configuring DNS (e.g. with `sslip.io`), or [using a Custom Domain](../serving/using-a-custom-domain). === "kubectl" @@ -187,7 +187,7 @@ cd knative-docs/docs/serving/samples/hello-world/helloworld-python ```shell NAME URL - helloworld-python http://helloworld-python.default.1.2.3.4.xip.io + helloworld-python http://helloworld-python.default.1.2.3.4.sslip.io ``` === "kn" @@ -199,7 +199,7 @@ cd knative-docs/docs/serving/samples/hello-world/helloworld-python Example: ```shell - http://helloworld-python.default.1.2.3.4.xip.io + http://helloworld-python.default.1.2.3.4.sslip.io ``` @@ -211,7 +211,7 @@ cd knative-docs/docs/serving/samples/hello-world/helloworld-python Example: ```shell - curl http://helloworld-python.default.1.2.3.4.xip.io + curl http://helloworld-python.default.1.2.3.4.sslip.io Hello Python Sample v1! # Even easier with kn: @@ -235,6 +235,3 @@ To remove the sample app from your cluster, delete the service record. ```shell kn service delete helloworld-python ``` - - - diff --git a/docs/serving/samples/hello-world/helloworld-ruby/index.md b/docs/serving/samples/hello-world/helloworld-ruby/index.md index 5c949ce0c..db211c0fb 100644 --- a/docs/serving/samples/hello-world/helloworld-ruby/index.md +++ b/docs/serving/samples/hello-world/helloworld-ruby/index.md @@ -23,7 +23,7 @@ cd knative-docs/docs/serving/samples/hello-world/helloworld-ruby ## Prerequisites - A Kubernetes cluster with Knative installed and DNS configured. Follow the - [installation instructions](../../../../install/README.md). + [installation instructions](../../../../install/). - [Docker](https://www.docker.com) installed and running on your local machine, and a Docker Hub account configured. - (optional) The Knative CLI client [kn](https://github.com/knative/client/releases) that simplifies the deployment. Alternative you can also use [`kubectl`](https://kubernetes.io/docs/tasks/tools/install-kubectl/) and apply resource files directly. @@ -169,7 +169,7 @@ cd knative-docs/docs/serving/samples/hello-world/helloworld-ruby 8.398s Ready to serve. Service 'helloworld-ruby' created to latest revision 'helloworld-ruby-akhft-1' is available at URL: - http://helloworld-ruby.default.1.2.3.4.xip.io + http://helloworld-ruby.default.1.2.3.4.sslip.io ``` @@ -197,7 +197,7 @@ cd knative-docs/docs/serving/samples/hello-world/helloworld-ruby ```shell NAME URL - helloworld-ruby http://helloworld-ruby.default.1.2.3.4.xip.io + helloworld-ruby http://helloworld-ruby.default.1.2.3.4.sslip.io ``` @@ -210,7 +210,7 @@ cd knative-docs/docs/serving/samples/hello-world/helloworld-ruby Example: ```shell - http://helloworld-ruby.default.1.2.3.4.xip.io + http://helloworld-ruby.default.1.2.3.4.sslip.io ``` @@ -222,7 +222,7 @@ cd knative-docs/docs/serving/samples/hello-world/helloworld-ruby Example: ```shell - curl http://helloworld-ruby.default.1.2.3.4.xip.io + curl http://helloworld-ruby.default.1.2.3.4.sslip.io Hello Ruby Sample v1! # Even easier with kn: @@ -247,6 +247,3 @@ To remove the sample app from your cluster, delete the service record. ```shell kn service delete helloworld-ruby ``` - - - diff --git a/docs/serving/samples/hello-world/helloworld-scala/index.md b/docs/serving/samples/hello-world/helloworld-scala/index.md index 8d2e47fcc..2e5275553 100644 --- a/docs/serving/samples/hello-world/helloworld-scala/index.md +++ b/docs/serving/samples/hello-world/helloworld-scala/index.md @@ -24,7 +24,7 @@ cd knative-docs/docs/serving/samples/hello-world/helloworld-scala ## Before you begin -- A Kubernetes cluster [installation](../../../../install/README.md) with +- A Kubernetes cluster [installation](../../../../install/) with Knative Serving up and running. - [Docker](https://www.docker.com) installed locally, and running, optionally a Docker Hub account configured or some other Docker Repository installed @@ -142,7 +142,7 @@ local Docker Repository. 8.398s Ready to serve. Service 'helloworld-scala' created to latest revision 'helloworld-scala-abcd-1' is available at URL: - http://helloworld-scala.default.1.2.3.4.xip.io + http://helloworld-scala.default.1.2.3.4.sslip.io ``` @@ -160,13 +160,13 @@ local Docker Repository. # It will print something like this, the URL is what you're looking for. # NAME URL - # helloworld-scala http://helloworld-scala.default.1.2.3.4.xip.io + # helloworld-scala http://helloworld-scala.default.1.2.3.4.sslip.io ``` Finally, to try your service, use the obtained URL: ```shell - curl -v http://helloworld-scala.default.1.2.3.4.xip.io + curl -v http://helloworld-scala.default.1.2.3.4.sslip.io ``` @@ -179,13 +179,13 @@ local Docker Repository. Example: ```shell - http://helloworld-scala.default.1.2.3.4.xip.io + http://helloworld-scala.default.1.2.3.4.sslip.io ``` Finally, to try your service, use the obtained URL: ```shell - curl -v http://helloworld-scala.default.1.2.3.4.xip.io + curl -v http://helloworld-scala.default.1.2.3.4.sslip.io ``` @@ -211,8 +211,3 @@ local Docker Repository. ```shell kn service delete helloworld-scala ``` - - - - - diff --git a/docs/serving/samples/hello-world/helloworld-shell/index.md b/docs/serving/samples/hello-world/helloworld-shell/index.md index 12dc56b1d..84d376a3b 100644 --- a/docs/serving/samples/hello-world/helloworld-shell/index.md +++ b/docs/serving/samples/hello-world/helloworld-shell/index.md @@ -24,7 +24,7 @@ cd knative-docs/docs/serving/samples/hello-world/helloworld-shell ## Prerequisites - A Kubernetes cluster with Knative installed and DNS configured. Follow the - [installation instructions](../../../../install/README.md). + [installation instructions](../../../../install/). - [Docker](https://www.docker.com) installed and running on your local machine, and a Docker Hub account configured. - Optional: You can use the Knative CLI client [`kn`](https://github.com/knative/client/releases) to simplify resource creation and deployment. Alternatively, you can use `kubectl` to apply resource files directly. @@ -90,7 +90,7 @@ folder) you're ready to build and deploy the sample app. 1. After the build has completed and the container is pushed to Docker Hub, you can deploy the app into your cluster. - + === "yaml" 1. Create a new file, `service.yaml` and copy the following service definition @@ -146,7 +146,7 @@ folder) you're ready to build and deploy the sample app. 8.398s Ready to serve. Service 'helloworld-shell' created to latest revision 'helloworld-shell-kwdpt-1' is available at URL: - http://helloworld-shell.default.1.2.3.4.xip.io + http://helloworld-shell.default.1.2.3.4.sslip.io ``` @@ -164,7 +164,7 @@ folder) you're ready to build and deploy the sample app. 1. Run one of the followings commands to find the domain URL for your service. - + === "kubectl" ```shell kubectl get ksvc helloworld-shell --output=custom-columns=NAME:.metadata.name,URL:.status.url @@ -174,7 +174,7 @@ folder) you're ready to build and deploy the sample app. ```shell NAME URL - helloworld-shell http://helloworld-shell.default.1.2.3.4.xip.io + helloworld-shell http://helloworld-shell.default.1.2.3.4.sslip.io ``` @@ -187,7 +187,7 @@ folder) you're ready to build and deploy the sample app. Example: ```shell - http://helloworld-shell.default.1.2.3.4.xip.io + http://helloworld-shell.default.1.2.3.4.sslip.io ``` @@ -199,7 +199,7 @@ folder) you're ready to build and deploy the sample app. Example: ```shell - curl http://helloworld-shell.default.1.2.3.4.xip.io + curl http://helloworld-shell.default.1.2.3.4.sslip.io Hello Shell Sample v1! # Even easier with kn: @@ -222,6 +222,3 @@ To remove the sample app from your cluster, delete the service record. ```shell kn service delete helloworld-shell ``` - - - diff --git a/docs/serving/samples/knative-routing-go/index.md b/docs/serving/samples/knative-routing-go/index.md index 59fe1ccac..a49981520 100644 --- a/docs/serving/samples/knative-routing-go/index.md +++ b/docs/serving/samples/knative-routing-go/index.md @@ -22,7 +22,7 @@ the Login service. ## Prerequisites -1. A Kubernetes cluster with [Knative Serving](../../../install/README.md) +1. A Kubernetes cluster with [Knative Serving](../../../install/) installed. 2. Install [Docker](https://docs.docker.com/get-started/#prepare-your-docker-environment). diff --git a/docs/serving/samples/multi-container/index.md b/docs/serving/samples/multi-container/index.md index bd3692d9f..723400d87 100644 --- a/docs/serving/samples/multi-container/index.md +++ b/docs/serving/samples/multi-container/index.md @@ -12,7 +12,7 @@ A simple web app written in Go that you can use for multi container testing. ## Prerequisites - A Kubernetes cluster with Knative installed and DNS configured. Follow the - [installation instructions](../../../install/README.md) if you need to + [installation instructions](../../../install/) if you need to create one. - [Docker](https://www.docker.com) installed and running on your local machine, and a Docker Hub account configured (we'll use it for a container registry). @@ -246,14 +246,14 @@ After you have modified the sample code files you can build and deploy the sampl ```shell NAME URL - multi-container http://multi-container.default.1.2.3.4.xip.io + multi-container http://multi-container.default.1.2.3.4.sslip.io ``` 1. Now you can make a request to your app and see the result. Replace the URL below with the URL returned in the previous command. ```shell - curl http://multi-container.default.1.2.3.4.xip.io + curl http://multi-container.default.1.2.3.4.sslip.io Yay!! multi-container works ``` diff --git a/docs/serving/samples/rest-api-go/index.md b/docs/serving/samples/rest-api-go/index.md index c8e827a47..0daa54ff4 100644 --- a/docs/serving/samples/rest-api-go/index.md +++ b/docs/serving/samples/rest-api-go/index.md @@ -14,7 +14,7 @@ like `AAPL`,`AMZN`, `GOOG`, `MSFT`, etc. ## Prerequisites -1. A Kubernetes cluster with [Knative Serving](../../../install/README.md) installed +1. A Kubernetes cluster with [Knative Serving](../../../install/) installed and DNS configured. 1. [Docker](https://docs.docker.com/get-started/#prepare-your-docker-environment) installed locally. @@ -160,7 +160,7 @@ and then you run `curl` commands to send request with your stock symbol. ```shell kubectl get ksvc stock-service-example --output=custom-columns=NAME:.metadata.name,URL:.status.url NAME URL - stock-service-example http://stock-service-example.default.1.2.3.4.xip.io + stock-service-example http://stock-service-example.default.1.2.3.4.sslip.io ``` 2. Send requests to the service using `curl`: @@ -168,7 +168,7 @@ and then you run `curl` commands to send request with your stock symbol. 1. Send a request to the index endpoint: ```shell - curl http://stock-service-example.default.1.2.3.4.xip.io + curl http://stock-service-example.default.1.2.3.4.sslip.io ``` Response body: `Welcome to the stock app!` @@ -176,7 +176,7 @@ and then you run `curl` commands to send request with your stock symbol. 2. Send a request to the `/stock` endpoint: ```shell - curl http://stock-service-example.default.1.2.3.4.xip.io/stock + curl http://stock-service-example.default.1.2.3.4.sslip.io/stock ``` Response body: `stock ticker not found!, require /stock/{ticker}` @@ -185,7 +185,7 @@ and then you run `curl` commands to send request with your stock symbol. "[stock symbol](https://www.marketwatch.com/tools/quotes/lookup.asp)": ```shell - curl http://stock-service-example.default.1.2.3.4.xip.io/stock/ + curl http://stock-service-example.default.1.2.3.4.sslip.io/stock/ ``` where `` is your "stock symbol". @@ -197,14 +197,14 @@ and then you run `curl` commands to send request with your stock symbol. Request: ```shell - curl http://stock-service-example.default.1.2.3.4.xip.io/stock/FAKE + curl http://stock-service-example.default.1.2.3.4.sslip.io/stock/FAKE ``` Response: `stock price for ticker FAKE is 0.00` ## Next Steps -The [traffic splitting example](../traffic-splitting/README.md) continues from +The [traffic splitting example](../traffic-splitting/) continues from here to walk you through how to create new Revisions and then use traffic splitting between those Revisions. diff --git a/docs/serving/samples/secrets-go/index.md b/docs/serving/samples/secrets-go/index.md index f1c38eacf..77be424c3 100644 --- a/docs/serving/samples/secrets-go/index.md +++ b/docs/serving/samples/secrets-go/index.md @@ -24,7 +24,7 @@ cd knative-docs/docs/serving/samples/secrets-go ## Before you begin - A Kubernetes cluster with Knative installed. Follow the - [installation instructions](../../../install/README.md) if you need to create + [installation instructions](../../../install/) if you need to create one. - [Docker](https://www.docker.com) installed and running on your local machine, and a Docker Hub account configured (we'll use it for a container registry). @@ -239,14 +239,14 @@ folder) you're ready to build and deploy the sample app. ```shell NAME URL - secrets-go http://secrets-go.default.1.2.3.4.xip.io + secrets-go http://secrets-go.default.1.2.3.4.sslip.io ``` 1. Now you can make a request to your app and see the result. Replace the URL below with the URL returned in the previous command. ```shell - curl http://secrets-go.default.1.2.3.4.xip.io + curl http://secrets-go.default.1.2.3.4.sslip.io bucket knative-secrets-sample, created at 2019-02-01 14:44:05.804 +0000 UTC, is located in US with storage class MULTI_REGIONAL ``` diff --git a/docs/serving/services/deployment.md b/docs/serving/services/deployment.md index b6bde36d4..e08a16ecd 100644 --- a/docs/serving/services/deployment.md +++ b/docs/serving/services/deployment.md @@ -21,7 +21,7 @@ kubectl get configmap -n knative-serving config-deployment -oyaml ## Configuring progress deadlines Configuring progress deadline settings allows you to specify the maximum time, either in seconds or minutes, that you will wait for your Deployment to progress before the system reports back that the Deployment has failed progressing for the Knative Revision. -By default, this value is set to 120 seconds. +By default, this value is set to 600 seconds. The value is expressed as a Go `time.Duration` string representation, but must be rounded to a second precision. The Knative Autoscaler component scales the revision to 0, and the Knative service enters a terminal `Failed` state, if the initial scale cannot be achieved within the time limit defined by this setting. diff --git a/docs/serving/spec/knative-api-specification-1.0.md b/docs/serving/spec/knative-api-specification-1.0.md deleted file mode 100644 index 79ff74683..000000000 --- a/docs/serving/spec/knative-api-specification-1.0.md +++ /dev/null @@ -1,3 +0,0 @@ -# Knative Serving API Specification - -This file has been moved to the [Knative Specs Repository](https://github.com/knative/specs/blob/main/specs/serving/knative-api-specification-1.0.md) diff --git a/docs/serving/using-a-custom-domain.md b/docs/serving/using-a-custom-domain.md index ec16bcca0..11dcfb761 100644 --- a/docs/serving/using-a-custom-domain.md +++ b/docs/serving/using-a-custom-domain.md @@ -90,7 +90,7 @@ You can also apply an updated domain configuration: > deployed services and routes. Deploy an app (for example, -[`helloworld-go`](./samples/hello-world/helloworld-go/README.md)), to your +[`helloworld-go`](./samples/hello-world/helloworld-go/)), to your cluster as normal. You can retrieve the URL in Knative Route "helloworld-go" with the following command: @@ -141,7 +141,7 @@ Follow these steps to make your domain publicly accessible: ### Set static IP for Knative Gateway You might want to -[set a static IP for your Knative gateway](./gke-assigning-static-ip-address.md), +[set a static IP for your Knative gateway](./gke-assigning-static-ip-address), so that the gateway IP does not change each time your cluster is restarted. ### Update your DNS records diff --git a/docs/serving/using-auto-tls.md b/docs/serving/using-auto-tls.md index 9fe3340e5..26990bfb5 100644 --- a/docs/serving/using-auto-tls.md +++ b/docs/serving/using-auto-tls.md @@ -200,12 +200,10 @@ in the `knative-serving` namespace to reference your new `ClusterIssuer`. 1. Add the `issuerRef` within the `data` section: ```shell - ... data: - ... issuerRef: | kind: ClusterIssuer - name: letsencrypt-issuer + name: letsencrypt-http01-issuer ``` Example: @@ -249,11 +247,8 @@ requests are handled: 1. Add the `autoTLS: Enabled` attribute under the `data` section: ```shell - ... data: - ... autoTLS: Enabled - ... ``` Example: @@ -287,11 +282,8 @@ requests are handled: clients to use HTTPS. ```shell - ... data: - ... - autoTLS: Enabled - ... + httpProtocol: Redirected ``` Example: @@ -305,7 +297,6 @@ requests are handled: data: ... autoTLS: Enabled - ... httpProtocol: Redirected ... ``` diff --git a/docs/serving/using-external-dns-on-gcp.md b/docs/serving/using-external-dns-on-gcp.md index e81a45dd5..de5875e99 100644 --- a/docs/serving/using-external-dns-on-gcp.md +++ b/docs/serving/using-external-dns-on-gcp.md @@ -118,7 +118,7 @@ permission to get the credential secret can access your Cloud DNS. ## Set up Knative -1. Follow the [instruction](../install/README.md) to install Knative on your +1. Follow the [instruction](../install/) to install Knative on your cluster. 1. Configure Knative to use your custom domain. diff --git a/docs/snippets/links/main-docs-branch-link.md b/docs/snippets/links/main-docs-branch-link.md new file mode 100644 index 000000000..1fcd12fd1 --- /dev/null +++ b/docs/snippets/links/main-docs-branch-link.md @@ -0,0 +1 @@ +[https://github.com/knative/docs/tree/mkdocs](https://github.com/knative/docs/tree/mkdocs) diff --git a/go.mod b/go.mod index 7932746fa..7097f9499 100644 --- a/go.mod +++ b/go.mod @@ -30,7 +30,7 @@ require ( gopkg.in/go-playground/webhooks.v3 v3.13.0 gopkg.in/yaml.v2 v2.3.0 honnef.co/go/tools v0.0.1-2020.1.5 // indirect - knative.dev/hack v0.0.0-20210426064739-88c69cd1eca7 + knative.dev/hack v0.0.0-20210428122153-93ad9129c268 ) replace go.opencensus.io => go.opencensus.io v0.20.2 diff --git a/go.sum b/go.sum index c18ae698d..d019e825a 100644 --- a/go.sum +++ b/go.sum @@ -539,8 +539,8 @@ honnef.co/go/tools v0.0.1-2020.1.3/go.mod h1:X/FiERA/W4tHapMX5mGpAtMSVEeEUOyHaw9 honnef.co/go/tools v0.0.1-2020.1.4/go.mod h1:X/FiERA/W4tHapMX5mGpAtMSVEeEUOyHaw9vFzvIQ3k= honnef.co/go/tools v0.0.1-2020.1.5 h1:nI5egYTGJakVyOryqLs1cQO5dO0ksin5XXs2pspk75k= honnef.co/go/tools v0.0.1-2020.1.5/go.mod h1:X/FiERA/W4tHapMX5mGpAtMSVEeEUOyHaw9vFzvIQ3k= -knative.dev/hack v0.0.0-20210426064739-88c69cd1eca7 h1:Z5icQ2KNCDSzTcHWMGI3KzdK/BpmgkGYdTX0RRzZul0= -knative.dev/hack v0.0.0-20210426064739-88c69cd1eca7/go.mod h1:PHt8x8yX5Z9pPquBEfIj0X66f8iWkWfR0S/sarACJrI= +knative.dev/hack v0.0.0-20210428122153-93ad9129c268 h1:lBIj9Epd9UQ55NEaHzAdY/UZbuaegCdGPKVC2+Z68Q0= +knative.dev/hack v0.0.0-20210428122153-93ad9129c268/go.mod h1:PHt8x8yX5Z9pPquBEfIj0X66f8iWkWfR0S/sarACJrI= rsc.io/binaryregexp v0.2.0/go.mod h1:qTv7/COck+e2FymRvadv62gMdZztPaShugOCi3I+8D8= rsc.io/quote/v3 v3.1.0/go.mod h1:yEA65RcK8LyAZtP9Kv3t0HmxON59tX3rD+tICJqUlj0= rsc.io/sampler v1.3.0/go.mod h1:T1hPZKmBbMNahiBKFy5HrXp6adAjACjK9JXDnKaTXpA= diff --git a/help/contributor/how-to/shortcodes.md b/help/contributor/how-to/shortcodes.md index 7fe7d64ec..1c9aa9f58 100644 --- a/help/contributor/how-to/shortcodes.md +++ b/help/contributor/how-to/shortcodes.md @@ -5,10 +5,9 @@ weight: "50" type: "docs" --- -A list and examples of the custom shortcodes that are currently used and available -in knative.dev. +A list and examples of the custom shortcodes that are currently used and available in knative.dev. -STAUS: This page is in "draft state" and needs to be completed. +STATUS: This page is in "draft state" and needs to be completed. ## Knative custom shortcodes @@ -42,7 +41,7 @@ https://github.com/knative/website/blob/main/layouts/shortcodes/readfile.md Use them to reduce release maintenance and ensure content accuracy. -The following variable are dynamically populated based on the URL of the content in knative.dev: +The following variables are dynamically populated based on the URL of the content in knative.dev: - The [branch shortcode](https://github.com/knative/website/blob/main/layouts/shortcodes/branch.md) {{< branch >}} renders: `{{< branch >}}` - The [version shortcode](https://github.com/knative/website/blob/main/layouts/shortcodes/version.md) {{< version >}} renders: `{{< version >}}` diff --git a/help/contributor/publishing.md b/help/contributor/publishing.md index 00403102a..f803cf5b0 100644 --- a/help/contributor/publishing.md +++ b/help/contributor/publishing.md @@ -1,6 +1,6 @@ --- title: "Staging and publishing Knative documentation" -linkTitle: "Website help" +linkTitle: "Preview Website" weight: "60" type: "docs" --- diff --git a/help/maintainer/docs-release-process.md b/help/maintainer/docs-release-process.md index 44c723650..b9870608d 100644 --- a/help/maintainer/docs-release-process.md +++ b/help/maintainer/docs-release-process.md @@ -11,22 +11,12 @@ branch and corresponding section knative.dev. ## Before you begin -* For updating and building website on knative.dev - * Be granted access to Netlify for staging - * Contact Caroline Lee or Richie Escarez - * For GitHub * [Set up keys for SSH access](https://docs.github.com/en/github/authenticating-to-github/connecting-to-github-with-ssh) * [Configure two remote repos](https://articles.assembla.com/en/articles/1136998-how-to-add-a-new-remote-to-your-git-repo) for your local /docs and /website clones: * "origin" - pointed at main repo (git@github.com:knative/docs.git) * "upstream" - pointed at your fork of main repo (git@github.com:/docs.git) -* For building website locally: - * [Install Hugo](https://www.docsy.dev/docs/getting-started/#install-hugo) - * (for Mac) Install gnu-sed using brew: brew install gnu-sed - * Update path to gnu-sed: `PATH="/usr/local/opt/gnu-sed/libexec/gnubin:$PATH"` - * [Go version 1.11+](https://golang.org/dl/) - * Clone git@github.com:knative/website.git (has build script) * To create combined PRs. Make your first pull request, choose Create a new branch. Give it a name you will remember. Then when you make your subsequent updates, make sure you select the branch you just created so you can add all your diff --git a/mkdocs.yml b/mkdocs.yml index 17f03c3bd..1b751cba9 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -256,6 +256,7 @@ markdown_extensions: - pymdownx.caret - pymdownx.mark - pymdownx.tilde + - pymdownx.escapeall - pymdownx.tasklist: custom_checkbox: true - admonition diff --git a/template-docs-page.md b/template-docs-page.md index 769050ddf..2066a80d8 100644 --- a/template-docs-page.md +++ b/template-docs-page.md @@ -84,7 +84,7 @@ Knative-specific stuff below. For example: ``` To complete the steps in this task, you must ..... meet/have/install/create/? the following: -- A Kubernetes cluster with [Knative installed](./docs/install/README.md). +- A Kubernetes cluster with [Knative installed](./docs/install/). - The latest version of ... running? - Privileges to ..... @@ -225,7 +225,7 @@ This is where you get past any of the non-Knative items so that you can focus on To complete the steps in this task, you must ..... meet/have/install/create/? the following: -- A Kubernetes cluster with [Knative installed](./docs/install/README.md). +- A Kubernetes cluster with [Knative installed](./docs/install/). - The latest version of ... running? - Privileges to ..... diff --git a/vendor/knative.dev/hack/codegen-library.sh b/vendor/knative.dev/hack/codegen-library.sh index 062b90499..ae5130f32 100644 --- a/vendor/knative.dev/hack/codegen-library.sh +++ b/vendor/knative.dev/hack/codegen-library.sh @@ -29,7 +29,7 @@ export GOPATH=$(go_mod_gopath_hack) export GOBIN=${GOPATH}/bin # Set GOBIN explicitly as deepcopy-gen is installed by go install. export MODULE_NAME=$(go_mod_module_name) export CODEGEN_PKG=${CODEGEN_PKG:-$(cd ${REPO_ROOT_DIR}; ls -d -1 ./vendor/k8s.io/code-generator 2>/dev/null || echo ../code-generator)} -export KNATIVE_CODEGEN_PKG=${KNATIVE_CODEGEN_PKG:-$(cd ${REPO_ROOT_DIR}; ls -d -1 ./vendor/knative.dev/pkg 2>/dev/null || echo ../pkg)} +export KNATIVE_CODEGEN_PKG=${KNATIVE_CODEGEN_PKG:-$(cd ${REPO_ROOT_DIR}; ls -d -1 ./vendor/knative.dev/pkg 2>/dev/null || echo "${REPO_ROOT_DIR}")} chmod +x ${CODEGEN_PKG}/generate-groups.sh chmod +x ${KNATIVE_CODEGEN_PKG}/hack/generate-knative.sh diff --git a/vendor/knative.dev/hack/presubmit-tests.sh b/vendor/knative.dev/hack/presubmit-tests.sh index fb50ac819..f3f7738b6 100644 --- a/vendor/knative.dev/hack/presubmit-tests.sh +++ b/vendor/knative.dev/hack/presubmit-tests.sh @@ -296,6 +296,15 @@ function main() { echo ">> docker version" docker version fi + if type java > /dev/null; then + echo ">> java version" + java -version + echo "JAVA_HOME: $JAVA_HOME" + fi + if type mvn > /dev/null; then + echo ">> maven version" + mvn --version + fi fi [[ -z $1 ]] && set -- "--all-tests" diff --git a/vendor/modules.txt b/vendor/modules.txt index dcd40f84b..6113fd14d 100644 --- a/vendor/modules.txt +++ b/vendor/modules.txt @@ -286,7 +286,7 @@ gopkg.in/go-playground/webhooks.v3/github gopkg.in/yaml.v2 # honnef.co/go/tools v0.0.1-2020.1.5 ## explicit -# knative.dev/hack v0.0.0-20210426064739-88c69cd1eca7 +# knative.dev/hack v0.0.0-20210428122153-93ad9129c268 ## explicit knative.dev/hack # go.opencensus.io => go.opencensus.io v0.20.2