diff --git a/keps/draft-0003-kep-cli.md b/keps/draft-0003-kep-cli.md deleted file mode 100644 index 461f412b7..000000000 --- a/keps/draft-0003-kep-cli.md +++ /dev/null @@ -1,133 +0,0 @@ ---- -kep-number: draft-20190214 -title: KEP CLI Proposal -authors: - - "@fabianbaier" -owners: - - TBD - - "@fabianbaier" -editor: TBD -creation-date: 2019-02-14 -status: provisional ---- - -# KEP CLI Proposal - -## Table of Contents - -* [KEP CLI Proposal](#kep-cli-proposal) - * [Table of Contents](#table-of-contents) - * [Summary](#summary) - * [Motivation](#motivation) - * [Goals](#goals) - * [Non-Goals](#non-goals) - * [Proposal](#proposal) - * [User Stories](#user-stories) - * [Installing a Framework](#installing-a-framework) - * [Uninstalling a Framework](#uninstalling-a-framework) - * [Listing running Instances](#listing-running-instances) - * [Getting the status of an Instance](#getting-the-status-of-an-instance) - * [Start specific plans](#start-specific-plans) - * [Get the history of Planexecutions](#get-the-history-of-planexecutions) - * [Executing into a particular Instance](#executing-into-a-particular-instance) - * [Run Framework specific commands](#run-framework-specific-commands) - * [Shell into containers of a Framework](#shell-into-containers-of-a-framework) - * [Read all combined logs of a Framework](#read-all-combined-logs-of-a-framework) - * [Implementation Details/Notes/Constraints](#implementation-detailsnotesconstraints) - * [Risks and Mitigations](#risks-and-mitigations) - * [Graduation Criteria](#graduation-criteria) - * [Implementation History](#implementation-history) - -## Summary - -This KEP aims to improve the end user experience via a CLI that makes the life of an operator easier. Right now, -interacting with KUDO consists of a chain of cumbersome steps that require specific business logic. By providing one -global entry point for the user (e.g. to install or interact with frameworks, get the status of current plans etc.) we -can abstract complexity from the user and drive adaptation. - -## Motivation - -Currently, installing your `Frameworks` requires not just the proper configuration of your YAML files but also multiple -interactions with `kubectl`. Having CLI tooling to simplify the path for cluster operators to deployment and maintenance - of installed `Frameworks` adds not just value across the community but also helps implementing best practices when using KUDO. - -### Goals - -The goal of this KEP is to have a CLI binary that can be used under the Kubectl Plugin System to work with KUDO. - -- We should drive making the adaption to KUDO easier -- Not to confuse flags -- Providing metrics for usage and error reporting - -### Non-Goals - -Non-Goals are: - -- Just building another wrapper around `kubectl` -- Adding complexity - -## Proposal - -This is where we get down to the nitty gritty of what the proposal actually is. - -### User Stories - -#### Installing a Framework - -As a user I want to be able to install a framework to my cluster. - -#### Uninstalling a Framework - -As a user I want to be able to uninstall a framework from my cluster. - -#### Listing running Instances - -As a user I want to be able to list current installed frameworks in my namespace. - -#### Getting the status of an Instance - -As a user I want to be able to get the status of all plans of an Instance. - -#### Start specific plans - -As a user I want to be able to trigger specific plans of an Instance. - -#### Get the history of Planexecutions - -As a user I want to be able to audit the trail of executed plans. - -#### Executing into a particular Instance - -As a user I want to be able to execute into my Instance environment. - -#### Run Framework specific commands - -As an application operator, I want to be able to run CLI tooling, built for the Framework against an Instance. - -#### 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 - -As a user I want to be able to read logs to a specific framework and its components. - -### Implementation Details/Notes/Constraints - -Some caveats: - -- Airgapped clusters -- Application logic with extra plugins for specific frameworks -- To be continued... - -### Risks and Mitigations - -TBD - -## Graduation Criteria - -If we see adoption in the community. - -## Implementation History - -TBD \ No newline at end of file