[KEP 0003] Initial Draft for 0003-kep-cli.md #118

fabianbaier · 2019-02-15T01:14:18Z

This KEP is for the KUDO CLI.

gerred

Looks pretty good. We don't have to put that non-goal in if we don't want to, it's just the only thing I can think of other than spelling.

keps/draft-0003-kep-cli.md

runyontr · 2019-02-15T10:42:45Z

keps/draft-0003-kep-cli.md

+
+As a user I want to be able to list current installed frameworks in my namespace.
+
+#### Getting the status of a running framework


You mean Instance?

Yes, and very good find! I see this important with kep-2 coming along to not confuse Framework with framework or Component. I had the fear that once we have dynamic CRDs the definition of Framework wouldn't apply here anymore and we would have to rewrite. Originally it was intended as running framework aka that would be an Instance.

I also think the user story should be getting the status of an Instance, leaving the running entirely out.

The Components in that branch are just a playground, those won't be merged in with those names.

keps/draft-0003-kep-cli.md

runyontr · 2019-02-15T10:44:05Z

keps/draft-0003-kep-cli.md

+
+#### Executing into a particular framework
+
+As a user I want to be able to execute into my framework environment.


This ones a little tricky. I'm not sure we're going to have a good use-case for this after we get the FrameworkCLI portion working (using Framework cli against an instance). What's an example use-case here?

I would also replace framework with Instance.

Then this was more thought of as having the option to bring up an Instance specific container similar to a busybox, just equipped with specific tooling for the environment. E.g. for Flink having a special flink-busybox with the FlinkCLI pre-installed.

When would they need this instead of just running the kubectl kudo flink cli <args> over and over again to interact?

keps/draft-0003-kep-cli.md

runyontr · 2019-02-15T10:46:13Z

keps/draft-0003-kep-cli.md

+
+As a user I want to be able to use framework specific logic, e.g. in Kafka create a topic or in Flink to upload a new job.
+
+#### Shell into containers of a framework


Same comment as Executing into a particular Framework. Not sure the difference between the two

Here the difference would lay in having directly access to the pods/containers itself of an Instance rather than launching next to it a busybox container as proposed in Executing into a particular Framework

runyontr · 2019-02-15T10:46:44Z

keps/draft-0003-kep-cli.md

+
+As a user I want to be able to get a shell to a specific framework.
+
+#### Read all combined logs of a framework


Just to think about as we implement. We should be able to identify where each log line came from.

How would we identify where each log line came from? We would have more control over events, so instead of logs should we focus more on events (don't have that here at all)? Otherwise maybe a simple wrapper around kubectl logs -l heritage=kudo,app=instance ?

joerg84 · 2019-02-15T19:27:16Z

keps/draft-0003-kep-cli.md

+
+### User Stories
+
+#### Installing a framework


I would use an instance of a framework as the typical user story would be to get a running (e.g., kafka) cluster.

joerg84 · 2019-02-15T19:27:40Z

keps/draft-0003-kep-cli.md

+
+As a user I want to be able to list current installed frameworks in my namespace.
+
+#### Getting the status of a running framework


keps/draft-0003-kep-cli.md

* Updated Mailing list link and OWNERS * Kudo Community.

* Update Mailing List in CONTRIBUTING * Fix linebreak. * Fix list formatting

* Provide local build instructions in CONTRIBUTING> * Remove kubebuilder dep. * Add docker build steps.

joerg84

Thanks, looks great. Maybe just wait for @runyontr review as he had some feedback on the earlier versions

* initial draft for 0003-kep-cli.md * Added Kubebuilder as prerequisite. (#116) * Simplified Docker build step in Makefile. (#117) * Updated Mailing list link and OWNERS (#119) * Updated Mailing list link and OWNERS * Kudo Community. * Update Release Process. (#120) * Update Slack link to point to channel. (#123) * Update Mailing List in CONTRIBUTING (#122) * Update Mailing List in CONTRIBUTING * Fix linebreak. * Fix list formatting * Add local build steps to CONTRIBUTING. (#124) * Provide local build instructions in CONTRIBUTING> * Remove kubebuilder dep. * Add docker build steps. * addressed review for 0003-kep-cli.md

initial draft for 0003-kep-cli.md

9166d71

fabianbaier added component/cli kubectl kudo a.k.a. kudoctl help wanted needs review kind/kep Kudo Enhancement labels Feb 15, 2019

fabianbaier requested review from gerred, runyontr and joerg84 February 15, 2019 01:14

gerred reviewed Feb 15, 2019

View reviewed changes

keps/draft-0003-kep-cli.md Show resolved Hide resolved

keps/draft-0003-kep-cli.md Outdated Show resolved Hide resolved

runyontr reviewed Feb 15, 2019

View reviewed changes

joerg84 reviewed Feb 15, 2019

View reviewed changes

joerg84 and others added 8 commits February 19, 2019 11:12

Added Kubebuilder as prerequisite. (#116)

26d626f

Simplified Docker build step in Makefile. (#117)

09054d1

Updated Mailing list link and OWNERS (#119)

c1dc42c

* Updated Mailing list link and OWNERS * Kudo Community.

Update Release Process. (#120)

64242cb

Update Slack link to point to channel. (#123)

1967781

Update Mailing List in CONTRIBUTING (#122)

3960302

* Update Mailing List in CONTRIBUTING * Fix linebreak. * Fix list formatting

Add local build steps to CONTRIBUTING. (#124)

c4c26e8

* Provide local build instructions in CONTRIBUTING> * Remove kubebuilder dep. * Add docker build steps.

addressed review for 0003-kep-cli.md

faf2df9

gerred approved these changes Feb 19, 2019

View reviewed changes

joerg84 approved these changes Feb 19, 2019

View reviewed changes

runyontr merged commit 0c6b23c into master Feb 20, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[KEP 0003] Initial Draft for 0003-kep-cli.md #118

[KEP 0003] Initial Draft for 0003-kep-cli.md #118

fabianbaier commented Feb 15, 2019

gerred left a comment

runyontr Feb 15, 2019

joerg84 Feb 15, 2019

fabianbaier Feb 15, 2019

runyontr Feb 20, 2019

runyontr Feb 15, 2019

fabianbaier Feb 15, 2019

runyontr Feb 20, 2019

runyontr Feb 15, 2019

fabianbaier Feb 15, 2019

runyontr Feb 15, 2019

fabianbaier Feb 15, 2019

joerg84 Feb 15, 2019

joerg84 Feb 15, 2019

joerg84 left a comment


		As a user I want to be able to list current installed frameworks in my namespace.

		#### Getting the status of a running framework


		#### Executing into a particular framework

		As a user I want to be able to execute into my framework environment.


		As a user I want to be able to use framework specific logic, e.g. in Kafka create a topic or in Flink to upload a new job.

		#### Shell into containers of a framework


		As a user I want to be able to get a shell to a specific framework.

		#### Read all combined logs of a framework

[KEP 0003] Initial Draft for 0003-kep-cli.md #118

[KEP 0003] Initial Draft for 0003-kep-cli.md #118

Conversation

fabianbaier commented Feb 15, 2019

gerred left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

joerg84 left a comment

Choose a reason for hiding this comment