-
Notifications
You must be signed in to change notification settings - Fork 262
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Adds basic workflow #99
Conversation
/retest |
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.
Moslty nits
docs/workflows.md
Outdated
In this basic worflow we show the CRUD (create, read, update, delete) operations on a service. We use a well known [simple Hello World service](https://github.com/knative/docs/tree/master/docs/serving/samples/hello-world/helloworld-go) that reads the environment variable `TARGET` and prints it as output. | ||
|
||
1. Create a service from image in `default` namespace |
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.
Your markdown renders the numbered list as 1. 1. 1, rather than numbering properly.
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.
Yeah, was afraid of that. I'll use bullet points. Thx.
## Basic (get your feet wet) | ||
|
||
In this basic worflow we show the CRUD (create, read, update, delete) operations on a service. We use a well known [simple Hello World service](https://github.com/knative/docs/tree/master/docs/serving/samples/hello-world/helloworld-go) that reads the environment variable `TARGET` and prints it as output. |
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.
s/basic//
docs/workflows.md
Outdated
The purpose of this section of the Kn documentation is to list what we believe are common workflows or use-cases for the Knative CLI. Obviously, as we release the CLI in the wild and get users in production, we might discover novel workflows. As we do we will improve this document. | ||
|
||
## Basic (get your feet wet) |
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.
s/Basic/Introductory/
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
docs/workflows.md
Outdated
# Workflows | ||
|
||
The purpose of this section of the Kn documentation is to list what we believe are common workflows or use-cases for the Knative CLI. Obviously, as we release the CLI in the wild and get users in production, we might discover novel workflows. As we do we will improve this document. |
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.
s/what we believe are//
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.
Thx
docs/workflows.md
Outdated
# Workflows | ||
|
||
The purpose of this section of the Kn documentation is to list what we believe are common workflows or use-cases for the Knative CLI. Obviously, as we release the CLI in the wild and get users in production, we might discover novel workflows. As we do we will improve this document. |
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.
s/Obviously....end of paragraph/This is a live document, meant to be updated as we learn more about good ways to use kn
/
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.
More concise. I like it. Thx
|
||
```bash | ||
$ kn service list |
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.
I think we agreed that this will be knative service get
(same semantics as in kubectl)
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 let me see if in latest code I can do this. Otherwise, I'll omit until ready.
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.
```bash | ||
$ kn service describe hello | ||
apiVersion: knative.dev/v1alpha1 |
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.
The output of kn service describe
will be always human readable, not yaml. Its kn service get hello -o yaml
which returns a machine readable representation (with the same -o
support as for kubectl as this is reused from Kubernete's cli-runtime).
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.
I'd agree with that. However, current implementation yielded YAML. I simply cut and pasted and edited to redact.
I'll try with latest code and if not ready I'll remove (for now).
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.
@rhuss no issue on this. Want to open it so we can see any feedback and I can address both.
docs/workflows.md
Outdated
```bash | ||
$ kn service delete hello3 | ||
$ Deleted hello3 in default namespace. |
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.
Sorry for nit-picking on high-level (pardonnez moi), but I would use here as a response:
Service 'hello3' in namespace 'default' deleted
(i.e. to make clear what is used provided data and mentioning early that's about a service)
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.
I like that. I'll submit a PR. Again output is as is in current code.
``` | ||
|
||
You can then issue the same `$ kn service list` command to verify that the service was deleted. |
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.
kn service get
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.
Yup yup.
docs/workflows.md
Outdated
|
||
```bash | ||
curl '-sS' '-H' 'Host: hello.default.example.com' 'http://xxx.xx.xxx.xx:80' |
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.
let's remove :80 from 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.
OK, fair enough.
docs/workflows.md
Outdated
``` | ||
|
||
Where `http://xxx.xx.xxx.xx:80` is your Knative installation ingress. |
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.
and here
i think it may also be useful to include output for all the commands ran. |
That's what I did. Some have no output (like |
/lgtm service get will be added when it's merged. |
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: cppforlife, maximilien 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 |
* Update spec file to release 1.6 * Cherry-pick test fixes, bump to client v1.6.1 --------- Co-authored-by: David Simansky <dsimansk@redhat.com>
Completes more of issue #51