Skip to content

Commit 72083c8

Browse files
mra-ruizk8s-ci-robot
authored andcommitted
fix(plugins/plugin-kubectl): Quickstart and Hello World Service Guidebooks
1 parent 15fad9b commit 72083c8

File tree

7 files changed

+15
-130
lines changed

7 files changed

+15
-130
lines changed

plugins/plugin-kubectl/notebooks/install-knative-quickstart.md

Lines changed: 13 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -5,29 +5,13 @@ layout:
55
default: wizard
66
wizard:
77
steps:
8-
- match: Install Knative using quickstart
9-
name: Install required tools
10-
- match: Install the Knative quickstart plugin
11-
name: Install and use the Knative quickstart plugin
8+
- name: Install required tools
9+
- name: Install the Knative quickstart plugin
1210
description: The plugin sets up Knative against kind by creating a kind cluster populated with Knative
1311
- Run the Knative quickstart plugin
12+
- Clean Up
1413
codeblocks:
15-
- match: ^brew install kn$
16-
validate: kn version
17-
- match: ^brew upgrade kn$
18-
optional: true
19-
- match: ^mv <path-to-binary-file> kn
20-
validate: kn version
21-
- match: ^mv kn /usr/local/bin$
22-
validate: kn version
23-
- match: ^git clone https://github.com/knative/client.git
24-
validate: $? -e 0 && exit 0 || exit 1
25-
- match: ^hack/build.sh -f$
26-
validate: $? -e 0 && exit 0 || exit 1
27-
- match: ^kn version$
28-
validate: $body
29-
- match: ^docker run --rm -v "$HOME/.kube/config:/root/.kube/config" gcr.io/knative-releases/knative.dev/client/cmd/kn:latest service list$
30-
validate: $? -e 0 && exit 0 || exit 1
14+
# validation for step 2: install the knative quickstart plugin
3115
- match: ^brew install knative-sandbox/kn-plugins/quickstart$
3216
validate: kn quickstart --help
3317
- match: ^brew upgrade knative-sandbox/kn-plugins/quickstart$
@@ -40,20 +24,20 @@ codeblocks:
4024
validate: $? -e 0 && exit 0 || exit 1
4125
- match: ^mv kn-quickstart /usr/local/bin$
4226
validate: kn quickstart --help
27+
# validation for step 3: Run the knative quickstart plugin
4328
- match: ^kn quickstart kind$
4429
validate: (kubectl cluster-info --context kind-knative) && exit 0 || exit 1
4530
- match: ^kn quickstart minikube$
4631
validate: minikube profile list
4732
- match: ^minikube tunnel --profile knative$
4833
validate: $? -e 0 && exit 0 || exit 1
34+
# Validation for Step 4: Clean Up
35+
- match: ^kubectl delete --filename service.yaml$
36+
- match : ^kn service delete helloworld-go$
37+
- match: ^kind delete clusters knative$
38+
validate: (kubectl cluster-info --context kind-knative) && exit 1 \|\| exit 0
39+
- match: ^minikube delete -p knative$
40+
validate: (kubectl cluster-info --context kind-knative) && exit 1 \|\| exit 0
4941
---
5042

51-
--8<-- "https://raw.githubusercontent.com/kubernetes-sigs/kui/master/plugins/plugin-kubectl/notebooks/knative-what-is-it-good-for.md"
52-
53-
---
54-
55-
--8<-- "https://raw.githubusercontent.com/mra-ruiz/docs/guidebooks/docs/getting-started/README.md"
56-
57-
---
58-
59-
--8<-- "https://raw.githubusercontent.com/mra-ruiz/docs/guidebooks/docs/getting-started/quickstart-install.md"
43+
--8<-- "https://raw.githubusercontent.com/mra-ruiz/docs/guidebooks/docs/guidebooks/install-knative-quickstart.md"

plugins/plugin-kubectl/notebooks/installing-serving-with-yaml.md

Lines changed: 0 additions & 5 deletions
This file was deleted.

plugins/plugin-kubectl/notebooks/kn-cli.md

Lines changed: 0 additions & 5 deletions
This file was deleted.

plugins/plugin-kubectl/notebooks/knative-first-service.md

Lines changed: 0 additions & 22 deletions
This file was deleted.

plugins/plugin-kubectl/notebooks/knative-serving-hello-world.md

Lines changed: 2 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -10,33 +10,13 @@ wizard:
1010
- match: Hello World - Go
1111
name: Building your application
1212
description: In this example, you will build a "Hello world" application
13-
- match: Deploying
14-
name: Deploying your service
13+
- name: Deploying
1514
description: After build is complete, push container to docker hub and then deploy your app into your cluster
1615
- match: Verifying
1716
name: Ping your Knative Service
1817
- match: Removing
1918
name: Clean Up
2019
codeblocks:
21-
# Validation for Knative CLI under step 1 Required Tools
22-
- match: ^(kn version >& /dev/null) && echo "You have the Knative CLI" \|\| (echo "Please install the Knative CLI" && exit 1)$
23-
validate: $body
24-
- match: ^brew install kn$
25-
validate: kn version
26-
- match: ^brew upgrade kn$
27-
optional: true
28-
- match: ^mv <path-to-binary-file> kn
29-
validate: kn version
30-
- match: ^mv kn /usr/local/bin$
31-
validate: kn version
32-
- match: ^git clone https://github.com/knative/client.git
33-
validate: $? -e 0 && exit 0 \|\| exit 1
34-
- match: ^hack/build.sh -f$
35-
validate: $? -e 0 && exit 0 \|\| exit 1
36-
- match: ^kn version$
37-
validate: $body
38-
- match: ^docker run --rm -v "$HOME/.kube/config:/root/.kube/config" gcr.io/knative-releases/knative.dev/client/cmd/kn:latest service list$
39-
validate: $? -e 0 && exit 0 \|\| exit 1
4020
# Validation for Step 2: Building your application
4121
- match: ^git clone https://github.com/knative/docs.git knative-docs
4222
validation: $? -e 0 && exit 0 \|\| exit 1
@@ -67,25 +47,4 @@ codeblocks:
6747
validate: (kubectl cluster-info --context kind-knative) && exit 1 \|\| exit 0
6848
---
6949

70-
--8<-- "https://raw.githubusercontent.com/kubernetes-sigs/kui/master/plugins/plugin-kubectl/notebooks/knative-what-is-it-good-for.md"
71-
72-
---
73-
74-
# Knative Serving - Deploying "Hello World"
75-
76-
This application will be deplyoyed as a Knative Service instead of a Kubernetes service.
77-
78-
---
79-
80-
# Install Required Tools
81-
82-
!!! note "Note - Installing Knative"
83-
If you install Knative using Quickstart, when you run the quickstart plugin, a cluster called `knative` will be created. To complete the deployment of the "Hello World" application, a pre-built app with a container already pushed to Docker hub will be used.
84-
85-
--8<-- "knative.md"
86-
87-
--8<-- "kn-cli.md"
88-
89-
--8<-- "https://raw.githubusercontent.com/mra-ruiz/docs/guidebooks/code-samples/serving/hello-world/helloworld-go/README.md"
90-
91-
--8<-- "https://raw.githubusercontent.com/mra-ruiz/docs/guidebooks/docs/getting-started/clean-up.md"
50+
--8<-- "https://raw.githubusercontent.com/mra-ruiz/docs/guidebooks/docs/guidebooks/knative-serving-hello-world.md"

plugins/plugin-kubectl/notebooks/knative.md

Lines changed: 0 additions & 25 deletions
This file was deleted.

plugins/plugin-kubectl/src/non-headless-preload.ts

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,6 @@ export default async (registrar: PreloadRegistrar) => {
7777
'plugin://plugin-kubectl/notebooks/knative-what-is-it-good-for.md',
7878
'plugin://plugin-kubectl/notebooks/install-knative-quickstart.md',
7979
'plugin://plugin-kubectl/notebooks/knative-quickstart.json',
80-
'plugin://plugin-kubectl/notebooks/knative-first-service.md',
8180
'plugin://plugin-kubectl/notebooks/knative-first-autoscale.md',
8281
'plugin://plugin-kubectl/notebooks/knative-traffic-splitting.md',
8382
'plugin://plugin-kubectl/notebooks/knative-introducing-eventing.md',

0 commit comments

Comments
 (0)