-
Notifications
You must be signed in to change notification settings - Fork 382
Change creates statements in walkthrough.md #2695
Change creates statements in walkthrough.md #2695
Conversation
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: mszostok The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
is okay-ish.
@@ -8,9 +8,6 @@ If you haven't, please see the [installation instructions](./install.md). Option | |||
the Service Catalog CLI, svcat. Examples for both svcat and kubectl are provided | |||
so that you may follow this walkthrough using svcat or using only kubectl. | |||
|
|||
All commands in this document assume that you're operating out of the root | |||
of this repository. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"... assume internet connectivity. Download the yaml ahead of time to etc etc etc."
Some people have to proxy in or out to github.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
but basically, k8s is doing that on their examples:
kubectl apply -f https://k8s.io/examples/controllers/nginx-deployment.yaml
but just using that with k8s.io
domain.
source: https://kubernetes.io/docs/concepts/workloads/controllers/deployment/#creating-a-deployment
In the future, we can also host examples under https://svc-cat.io site.
thanks to that you can copy-paste command directly to terminal without service catalog sources, so it's huge pros. What's more, you will know that the newest version was used.
In case of doing that with checkout repo, someone can have an old version (didnt execute git pull
for a long time)
but as you said such an approach requires the connection connectivity
So what is your idea? Leave it as it is and required that use checkout the service catalog locally as it was before?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ah, yes, the walkthrough is hosted.
https://svc-cat.io/docs/walkthrough/
Would be good to have it hosted on the domain, but not a blocker.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
ok, I will implement that in next pull-requests
@@ -23,7 +20,7 @@ We plan on using the minibroker for demo purposes. The codebase for that broker | |||
[here](https://github.com/kubernetes-sigs/minibroker). | |||
|
|||
We're going to deploy the minibroker to our Kubernetes cluster before | |||
proceeding, and we'll do so with the minibroker helm chart. You can find details about the chart in the minibroker README |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
good catch, dupe word.
@@ -480,7 +477,7 @@ Delete the helm deployment and the namespace: | |||
|
|||
```console | |||
helm delete --purge catalog | |||
kubectl delete ns svc-cat |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This should link back to other instructions rather than document how to clean up something else here.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
agree 👍
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
FYI: The best approach was to remove that thing. At the beginning of that walkthrough we have a prerequisite:
This document assumes that you've installed Service Catalog onto your cluster.
so I do not see any reason why we should have the delete action for SC at the end of the walkthrough. We can delete the minibroker because we are creating that during the walkthrough.
so the final shape:
# Step 1 - Installing the minibroker Server
# Step 2 - Viewing ClusterServiceClasses and ClusterServicePlans
# Step 4 - Creating a New ServiceInstance
# Step 5 - Requesting a ServiceBinding to use the ServiceInstance
# Step 6 - Deleting the ServiceBinding
# Step 7 - Deleting the ServiceInstance
# Step 8 - Deleting the ClusterServiceBroker
# Step 9 - Final Cleanup - delete minibroker and created namespaces
thanks to that the walkthrough is exactly about showing usage of SC
seems fine. forward progress. |
/hold |
- use URL to GitHub raw YAML content instead of local file - fix namespace name in cleaning up service catalog step
07081ae
to
1d47f0a
Compare
/lgtm |
/hold cancel |
Description