Skip to content

Commit

Permalink
Update some KEP status and refresh the list. (#1429)
Browse files Browse the repository at this point in the history
- Update the status to match reality.
- This also adds some emotes to the list - instant visual cue about the
individual and overall status

Signed-off-by: Marcin Owsiany <mowsiany@D2iQ.com>
  • Loading branch information
porridge committed Mar 19, 2020
1 parent 5c47566 commit b1ef318
Show file tree
Hide file tree
Showing 7 changed files with 52 additions and 32 deletions.
23 changes: 20 additions & 3 deletions hack/update_kep_overview.sh
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,8 @@ cat <<EOT > $KEP_OVERVIEW_FILE
*Please run /hack/update_kep_overview.sh after adding or updating a KEP*
| KEP | Status | Description |
| --- | ---: | --- |
| KEP | | Status | Description |
| --- | --- | ---: | --- |
EOT

for KEP in $KEP_FILES;
Expand All @@ -36,8 +36,25 @@ do

KEP_TITLE=$(echo "$KEP_HEADER" | sed -n -E 's/title: (.*)/\1/p')
KEP_STATUS=$(echo "$KEP_HEADER" | sed -n -E 's/status: (.*)/\1/p')
case $KEP_STATUS in
provisional)
KEP_ICON=":question:"
;;
implementable)
KEP_ICON=":heavy_plus_sign:"
;;
implemented)
KEP_ICON=":heavy_check_mark:"
;;
rejected)
KEP_ICON=":no_entry:"
;;
*)
KEP_ICON=""
;;
esac
KEP_DESC=$(echo "$KEP_HEADER" | sed -n -E 's/short-desc: (.*)/\1/p')

# Print one line for this KEP
echo "| [$KEP_NUMBER - $KEP_TITLE]($KEP_FILE) | $KEP_STATUS | $KEP_DESC |" >> $KEP_OVERVIEW_FILE
echo "| [$KEP_NUMBER - $KEP_TITLE]($KEP_FILE) | $KEP_ICON | $KEP_STATUS | $KEP_DESC |" >> $KEP_OVERVIEW_FILE
done
2 changes: 1 addition & 1 deletion keps/0017-pipe-tasks.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ owners:
editor: TBD
creation-date: 2019-09-12
last-updated: 2019-09-12
status: provisional
status: implemented
---

# Pipe Tasks
Expand Down
1 change: 1 addition & 0 deletions keps/0023-enable-disable-features.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
kep-number: 23
title: Enabling and Disabling features in KUDO Operators
short-desc: Enabling and Disabling features in KUDO Operators a.k.a. the Toggle task
authors:
- "@zmalik"
owners:
Expand Down
1 change: 1 addition & 0 deletions keps/0024-parameter-enhancement.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
kep-number: 24
title: Enhanced Operator Parameters
short-desc: Parameter types other than `string`
authors:
- "@nfnt"
owners:
Expand Down
2 changes: 1 addition & 1 deletion keps/0025-template-to-yaml-function.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ owners:
- "@porridge"
editor: @porridge
creation-date: 2020-02-25
last-updated: 2020-02-25
last-updated: 2020-03-02
status: implemented
see-also:
- KEP-24
Expand Down
5 changes: 3 additions & 2 deletions keps/0026-reading-parameter-values-from-a-file.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@ owners:
- "@porridge"
editor: @porridge
creation-date: 2020-02-25
last-updated: 2020-03-02
status: implementable
last-updated: 2020-03-18
status: implemented
see-also:
- KEP-24
- KEP-25
Expand Down Expand Up @@ -155,3 +155,4 @@ the relative order of different flags.

- 2020-02-25 - Initial draft. (@porridge)
- 2020-03-02 - Added example schema, updated references to other KEPs. (@porridge)
- 2020-03-18 - Updated status after merge of implementation. (@porridge)
50 changes: 25 additions & 25 deletions keps/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,28 +4,28 @@

*Please run /hack/update_kep_overview.sh after adding or updating a KEP*

| KEP | Status | Description |
| --- | ---: | --- |
| [0000 - KEP Template](0000-kep-template.md) | provisional | Use this template for new KEPs |
| [0001 - KUDO Enhancement Proposal Process](0001-kep-process.md) | implemented | Description of the KEP-Process |
| [0002 - Dynamic Instances](0002-dynamic-instances.md) | implementable | |
| [0003 - KEP CLI Proposal](0003-kep-cli.md) | implementable | Initial CLI description |
| [0004 - Add Testing Infrastructure](0004-add-testing-infrastructure.md) | implementable | What, where, when and how we will test |
| [0005 - Cluster Resources for CRDs](0005-cluster-resources-for-crds.md) | provisional | |
| [0006 - Stable Kafka Example](0006-stable-kafka-example.md) | provisional | |
| [0007 - CLI Skeleton generator](0007-cli-generation.md) | provisional | Generate operator skeletons for operator developers |
| [0008 - Operator Testing](0008-operator-testing.md) | implementable | Description of how to test operators |
| [0009 - New KUDO package format](0009-operator-toolkit.md) | implemented | Description of YAML operator definitions, features, plans/steps/tasks organization, templates and parameters |
| [0010 - Package Manager](0010-package-manager.md) | implementable | KUDO Packages and basic repository description |
| [0012 - Operator Extensions](0012-operator-extensions.md) | implementable | How to extend existing operators. Adding or modifying tasks and plans, etc. |
| [0013 - External Specs](0013-external-specs.md) | provisional | Run non-KUDO defined applications as Operators |
| [0014 - Pull Request Process](0014-pull-request-process.md) | rejected | Description of GitHub issues, labels, pull requests and commands |
| [0015 - Repository Management](0015-repository-management.md) | provisional | Details on repositories, how to generate, update and manage repos |
| [0017 - Pipe Tasks](0017-pipe-tasks.md) | provisional | Feature for a mechanism that allows piping of resources (files) from one task to another |
| [0018 - Controller redesign](0018-controller-overhaul.md) | implementable | Refactoring of KUDO controller |
| [0019 - Versioning of Operator Packages](0019-package-api-versioning.md) | implementable | Connection between the different versions that describe an operator |
| [0020 - Manual plan execution](0020-manual-plan-execution.md) | implemented | |
| [0023 - Enabling and Disabling features in KUDO Operators](0023-enable-disable-features.md) | implementable | |
| [0024 - Enhanced Operator Parameters](0024-parameter-enhancement.md) | implemented | |
| [0025 - Template toYaml function](0025-template-to-yaml-function.md) | implemented | New toYaml function for use in templates |
| [0026 - Reading parameter values from a file](0026-reading-parameter-values-from-a-file.md) | implementable | Reading parameter values from a file |
| KEP | | Status | Description |
| --- | --- | ---: | --- |
| [0000 - KEP Template](0000-kep-template.md) | :question: | provisional | Use this template for new KEPs |
| [0001 - KUDO Enhancement Proposal Process](0001-kep-process.md) | :heavy_check_mark: | implemented | Description of the KEP-Process |
| [0002 - Dynamic Instances](0002-dynamic-instances.md) | :heavy_plus_sign: | implementable | |
| [0003 - KEP CLI Proposal](0003-kep-cli.md) | :heavy_plus_sign: | implementable | Initial CLI description |
| [0004 - Add Testing Infrastructure](0004-add-testing-infrastructure.md) | :heavy_plus_sign: | implementable | What, where, when and how we will test |
| [0005 - Cluster Resources for CRDs](0005-cluster-resources-for-crds.md) | :question: | provisional | |
| [0006 - Stable Kafka Example](0006-stable-kafka-example.md) | :question: | provisional | |
| [0007 - CLI Skeleton generator](0007-cli-generation.md) | :question: | provisional | Generate operator skeletons for operator developers |
| [0008 - Operator Testing](0008-operator-testing.md) | :heavy_plus_sign: | implementable | Description of how to test operators |
| [0009 - New KUDO package format](0009-operator-toolkit.md) | :heavy_check_mark: | implemented | Description of YAML operator definitions, features, plans/steps/tasks organization, templates and parameters |
| [0010 - Package Manager](0010-package-manager.md) | :heavy_plus_sign: | implementable | KUDO Packages and basic repository description |
| [0012 - Operator Extensions](0012-operator-extensions.md) | :heavy_plus_sign: | implementable | How to extend existing operators. Adding or modifying tasks and plans, etc. |
| [0013 - External Specs](0013-external-specs.md) | :question: | provisional | Run non-KUDO defined applications as Operators |
| [0014 - Pull Request Process](0014-pull-request-process.md) | :no_entry: | rejected | Description of GitHub issues, labels, pull requests and commands |
| [0015 - Repository Management](0015-repository-management.md) | :question: | provisional | Details on repositories, how to generate, update and manage repos |
| [0017 - Pipe Tasks](0017-pipe-tasks.md) | :heavy_check_mark: | implemented | Feature for a mechanism that allows piping of resources (files) from one task to another |
| [0018 - Controller redesign](0018-controller-overhaul.md) | :heavy_plus_sign: | implementable | Refactoring of KUDO controller |
| [0019 - Versioning of Operator Packages](0019-package-api-versioning.md) | :heavy_plus_sign: | implementable | Connection between the different versions that describe an operator |
| [0020 - Manual plan execution](0020-manual-plan-execution.md) | :heavy_check_mark: | implemented | |
| [0023 - Enabling and Disabling features in KUDO Operators](0023-enable-disable-features.md) | :heavy_plus_sign: | implementable | Enabling and Disabling features in KUDO Operators a.k.a. the Toggle task |
| [0024 - Enhanced Operator Parameters](0024-parameter-enhancement.md) | :heavy_check_mark: | implemented | Parameter types other than `string` |
| [0025 - Template toYaml function](0025-template-to-yaml-function.md) | :heavy_check_mark: | implemented | New toYaml function for use in templates |
| [0026 - Reading parameter values from a file](0026-reading-parameter-values-from-a-file.md) | :heavy_check_mark: | implemented | Reading parameter values from a file |

0 comments on commit b1ef318

Please sign in to comment.