diff options
| author | Jianfei Hu <jianfeih@google.com> | 2018-12-07 11:06:44 -0800 |
|---|---|---|
| committer | Jianfei Hu <jianfeih@google.com> | 2018-12-07 11:06:44 -0800 |
| commit | 1b775253d3a0311c06da75f19334d25f5a35e174 (patch) | |
| tree | ba3b5c5a1ef60a5b92694f8f9ee7a9de45183ed6 /sig-cli | |
| parent | 7980908c2ff41bc78836e628fa0c903ea4b3587f (diff) | |
| parent | 6ac21ab4d415a459397f5cd2e6abd7b60ccac374 (diff) | |
Merge branch 'master' of https://github.com/kubernetes/community into patch-2
Diffstat (limited to 'sig-cli')
| -rw-r--r-- | sig-cli/README.md | 48 | ||||
| -rw-r--r-- | sig-cli/charter.md | 53 | ||||
| -rw-r--r-- | sig-cli/migrated-from-wiki/roadmap-kubectl.md | 4 | ||||
| -rw-r--r-- | sig-cli/outreachy.md | 64 |
4 files changed, 86 insertions, 83 deletions
diff --git a/sig-cli/README.md b/sig-cli/README.md index 6c3a1892..a82c20e1 100644 --- a/sig-cli/README.md +++ b/sig-cli/README.md @@ -5,13 +5,15 @@ Please do not edit this file directly, but instead make changes to the sigs.yaml file in the project root. To understand how this file is generated, see https://git.k8s.io/community/generator/README.md ---> +---> # CLI Special Interest Group Covers kubectl and related tools. We focus on the development and standardization of the CLI framework and its dependencies, the establishment of conventions for writing CLI commands, POSIX compliance, and improving the command line tools from a developer and devops user experience and usability perspective. +The [charter](charter.md) defines the scope and governance of the CLI Special Interest Group. + ## Meetings -* Regular SIG Meeting: [Wednesdays at 09:00 PT (Pacific Time)](https://zoom.us/my/sigcli) (biweekly). [Convert to your timezone](http://www.thetimezoneconverter.com/?t=09:00&tz=PT%20%28Pacific%20Time%29). +* Regular SIG Meeting: [Wednesdays at 09:00 PT (Pacific Time)](https://docs.google.com/document/d/1FQx0BPlkkl1Bn0c9ocVBxYIKojpmrS1CFP5h0DI68AE/edit) (biweekly). [Convert to your timezone](http://www.thetimezoneconverter.com/?t=09:00&tz=PT%20%28Pacific%20Time%29). * [Meeting notes and Agenda](https://docs.google.com/document/d/1r0YElcXt6G5mOWxwZiXgGu_X6he3F--wKwg-9UBc29I/edit?usp=sharing). * [Meeting recordings](https://www.youtube.com/playlist?list=PL69nYSiGNLP28HaTzSlFe6RJVxpFmbUvF). @@ -21,12 +23,19 @@ Covers kubectl and related tools. We focus on the development and standardizatio The Chairs of the SIG run operations and processes governing the SIG. * Maciej Szulik (**[@soltysh](https://github.com/soltysh)**), Red Hat +* Sean Sullivan (**[@seans3](https://github.com/seans3)**), Google + +### Technical Leads +The Technical Leads of the SIG establish new subprojects, decommission existing +subprojects, and resolve cross-subproject technical issues and decisions. + +* Maciej Szulik (**[@soltysh](https://github.com/soltysh)**), Red Hat * Phillip Wittrock (**[@pwittrock](https://github.com/pwittrock)**), Google -* Tony Ado (**[@AdoHe](https://github.com/AdoHe)**), Alibaba ## Emeritus Leads * Fabiano Franz (**[@fabianofranz](https://github.com/fabianofranz)**), Red Hat +* Tony Ado (**[@AdoHe](https://github.com/AdoHe)**), Alibaba ## Contact * [Slack](https://kubernetes.slack.com/messages/sig-cli) @@ -40,26 +49,31 @@ The following subprojects are owned by sig-cli: - Owners: - https://raw.githubusercontent.com/kubernetes/kubectl/master/OWNERS - https://raw.githubusercontent.com/kubernetes/kubernetes/master/pkg/kubectl/OWNERS +- **kustomize** + - Owners: + - https://raw.githubusercontent.com/kubernetes-sigs/kustomize/master/OWNERS +- **cli-sdk** + - Owners: + - https://raw.githubusercontent.com/kubernetes/cli-runtime/master/OWNERS + - https://raw.githubusercontent.com/kubernetes/kubernetes/master/staging/src/k8s.io/cli-runtime/OWNERS + - https://raw.githubusercontent.com/kubernetes/sample-cli-plugin/master/OWNERS + - https://raw.githubusercontent.com/kubernetes/kubernetes/master/staging/src/k8s.io/sample-cli-plugin/OWNERS ## GitHub Teams The below teams can be mentioned on issues and PRs in order to get attention from the right people. Note that the links to display team membership will only work if you are a member of the org. -The google groups contain the archive of Github team notifications. -Mentioning a team on Github will CC its group. -Monitor these for Github activity if you are not a member of the team. - -| Team Name | Details | Google Groups | Description | -| --------- |:-------:|:-------------:| ----------- | -| @kubernetes/sig-cli-api-reviews | [link](https://github.com/orgs/kubernetes/teams/sig-cli-api-reviews) | [link](https://groups.google.com/forum/#!forum/kubernetes-sig-cli-api-reviews) | API Changes and Reviews | -| @kubernetes/sig-cli-bugs | [link](https://github.com/orgs/kubernetes/teams/sig-cli-bugs) | [link](https://groups.google.com/forum/#!forum/kubernetes-sig-cli-bugs) | Bug Triage and Troubleshooting | -| @kubernetes/sig-cli-feature-requests | [link](https://github.com/orgs/kubernetes/teams/sig-cli-feature-requests) | [link](https://groups.google.com/forum/#!forum/kubernetes-sig-cli-feature-requests) | Feature Requests | -| @kubernetes/sig-cli-maintainers | [link](https://github.com/orgs/kubernetes/teams/sig-cli-maintainers) | [link](https://groups.google.com/forum/#!forum/kubernetes-sig-cli-maintainers) | CLI Maintainers | -| @kubernetes/sig-cli-misc | [link](https://github.com/orgs/kubernetes/teams/sig-cli-misc) | [link](https://groups.google.com/forum/#!forum/kubernetes-sig-cli-misc) | General Discussion | -| @kubernetes/sig-cli-pr-reviews | [link](https://github.com/orgs/kubernetes/teams/sig-cli-pr-reviews) | [link](https://groups.google.com/forum/#!forum/kubernetes-sig-cli-pr-reviews) | PR Reviews | -| @kubernetes/sig-cli-proposals | [link](https://github.com/orgs/kubernetes/teams/sig-cli-proposals) | [link](https://groups.google.com/forum/#!forum/kubernetes-sig-cli-proposals) | Design Proposals | -| @kubernetes/sig-cli-test-failures | [link](https://github.com/orgs/kubernetes/teams/sig-cli-test-failures) | [link](https://groups.google.com/forum/#!forum/kubernetes-sig-cli-test-failures) | Test Failures and Triage | +| Team Name | Details | Description | +| --------- |:-------:| ----------- | +| @kubernetes/sig-cli-api-reviews | [link](https://github.com/orgs/kubernetes/teams/sig-cli-api-reviews) | API Changes and Reviews | +| @kubernetes/sig-cli-bugs | [link](https://github.com/orgs/kubernetes/teams/sig-cli-bugs) | Bug Triage and Troubleshooting | +| @kubernetes/sig-cli-feature-requests | [link](https://github.com/orgs/kubernetes/teams/sig-cli-feature-requests) | Feature Requests | +| @kubernetes/sig-cli-maintainers | [link](https://github.com/orgs/kubernetes/teams/sig-cli-maintainers) | CLI Maintainers | +| @kubernetes/sig-cli-misc | [link](https://github.com/orgs/kubernetes/teams/sig-cli-misc) | General Discussion | +| @kubernetes/sig-cli-pr-reviews | [link](https://github.com/orgs/kubernetes/teams/sig-cli-pr-reviews) | PR Reviews | +| @kubernetes/sig-cli-proposals | [link](https://github.com/orgs/kubernetes/teams/sig-cli-proposals) | Design Proposals | +| @kubernetes/sig-cli-test-failures | [link](https://github.com/orgs/kubernetes/teams/sig-cli-test-failures) | Test Failures and Triage | <!-- BEGIN CUSTOM CONTENT --> diff --git a/sig-cli/charter.md b/sig-cli/charter.md new file mode 100644 index 00000000..8ce0dd18 --- /dev/null +++ b/sig-cli/charter.md @@ -0,0 +1,53 @@ +# SIG CLI Charter + +This charter adheres to the conventions described in the [Kubernetes Charter README] and uses +the Roles and Organization Management outlined in [sig-governance]. + +## Scope + +The Command Line Interface SIG (SIG CLI) is responsible for kubectl and +related tools. This group focuses on general purpose command line tools and +libraries to interface with Kubernetes API's. + +### In scope + +SIG CLI [README] + +#### Code, Binaries and Services + +SIG CLI code include general purpose command line tools and binaries for working +with Kubernetes API's. Examples of these binaries include: [kubectl and kustomize]. + +### Out of scope + +SIG CLI is not responsible for command-line tools built and maintained by other +SIGs, such as kubeadm, which is owned by SIG Cluster Lifecycle. SIG CLI is not +responsible for defining the Kubernetes API that it interfaces with. The +Kubernetes API is the responsibility of SIG API Machinery. + +## Roles and Organization Management + +SIG CLI adheres to the Roles and Organization Management outlined in [sig-governance] +and opts-in to updates and modifications to [sig-governance]. + +### Deviations from [sig-governance] + +- In addition to Technical Leads, SIG CLI defines Emeritus Leads. These former + SIG CLI leaders *SHOULD* be available to provide historical perspective and + domain knowledge. +- SIG CLI defines the role of Test Health Maintainer. Contributors who have + successfully completed one test on-call rotation within the last six months as + shown in the test on-call schedule of the [Test Playbook] are included in this + group. Test Health Maintainers are SIG CLI Members. + +### Subproject Creation + +Option 1: by [SIG Technical Leads](https://github.com/kubernetes/community/blob/master/committee-steering/governance/sig-governance.md#L100) + + +[Kubernetes Charter README]: https://github.com/kubernetes/community/blob/master/committee-steering/governance/README.md +[sig-governance]: https://github.com/kubernetes/community/blob/master/committee-steering/governance/sig-governance.md +[README]: https://github.com/kubernetes/community/blob/master/sig-cli/README.md +[kubectl and kustomize]: https://github.com/kubernetes/community/blob/master/sig-cli/README.md#subprojects +[Test Playbook]: https://docs.google.com/document/d/1Z3teqtOLvjAtE-eo0G9tjyZbgNc6bMhYGZmOx76v6oM + diff --git a/sig-cli/migrated-from-wiki/roadmap-kubectl.md b/sig-cli/migrated-from-wiki/roadmap-kubectl.md index 4fbf7a84..62d8b6e7 100644 --- a/sig-cli/migrated-from-wiki/roadmap-kubectl.md +++ b/sig-cli/migrated-from-wiki/roadmap-kubectl.md @@ -13,7 +13,7 @@ If you'd like to contribute, please read the [conventions](/contributors/devel/k ### Add new commands / subcommands / flags * [Simplify support for multiple files](https://github.com/kubernetes/kubernetes/issues/24649) * Manifest that can specify multiple files / http(s) URLs - * [Default manifest manifest](https://github.com/kubernetes/kubernetes/issues/3268) (ala Dockerfile or Makefile) + * [Default manifest](https://github.com/kubernetes/kubernetes/issues/3268) (ala Dockerfile or Makefile) * Unpack archive (tgz, zip) and then invoke â-fâ on that directory * URL shortening via default URL prefix * [Imperative `set` commands](https://github.com/kubernetes/kubernetes/issues/21648) @@ -103,7 +103,7 @@ If you'd like to contribute, please read the [conventions](/contributors/devel/k * [Eliminate round-trip conversion of API objects in kubectl](https://github.com/kubernetes/kubernetes/issues/3955) * [Move preferences out of kubeconfig](https://github.com/kubernetes/kubernetes/issues/10693) * And then add more preferences - * Enable/disable explanatory mode (see [kploy output](http://kubernetes.sh/kploy/)) + * Enable/disable explanatory mode (see [kploy output](https://github.com/kubernauts/kploy)) * Permanently disable warnings once displayed * Default labels as columns * Default `--record`, `--save-config`, etc. diff --git a/sig-cli/outreachy.md b/sig-cli/outreachy.md deleted file mode 100644 index 5b4db2bc..00000000 --- a/sig-cli/outreachy.md +++ /dev/null @@ -1,64 +0,0 @@ -# Outreachy - -Kubernetes, specifically the SIG-CLI, is happy to announce our participation in the Outreachy program, running from December 2017 to March 2018. -Please see the [main program page](https://www.outreachy.org/) for general information about the program, -such as its purpose, timeline, eligibility requirements, and how to apply. - -**Schedule** - -* October 23: application deadline for other Outreachy communities -* October 30: application deadline for Kubernetes Outreachy applications -* November 9: selection decisions are made -* December 5 - March 5: internship - -## What is Kubernetes? -Kubernetes is an open-source system for automating deployment, scaling, and management of containerized applications. -It groups containers that make up an application into logical units for easy management and discovery. Kubernetes builds upon 15 years of experience of running production workloads at Google, combined with best-of-breed ideas and practices from the community. -Please see [kubernetes.io](https://kubernetes.io/) for more details. - -## What are SIGs / What is SIG-CLI? -Kubernetes is a set of projects, each shepherded by a special interest group (SIG). To get a grasp of the projects that we work on, check out the complete [list of SIGs](/sig-list.md). -This [slide deck](https://docs.google.com/presentation/d/1JqcALpsg07eH665ZXQrIvOcin6SzzsIUjMRRVivrZMg) provides an overview of how the Kubernetes community is organized. - -SIG-CLI Covers kubectl and related tools. We focus on the development and standardization of the CLI framework and its dependencies, the establishment of conventions for writing CLI commands, POSIX compliance, and improving the command line tools from a developer and devops user experience and usability perspective. - -**Communication:** - -SIG-CLI Mailing List - kubernetes-sig-cli@googlegroups.com -Slack - http://slack.k8s.io/ for invite; #sig-cli channel - -**Mentors** - -Philip Wittrock - pwittrock@google.com -Similar to contacting the coordinators, the mentors can be contacted at any time either by sending messages to the mailing lists or slack channels. - -## Contribute - -As part of the application process, the Outreachy program recommends that candidates make small contributions to the project they intend to apply for. -To start working on the project, make sure to fill out the [CLA](/CLA.md) and check if you have the right environment with this guide. -The README in the [community repo](https://github.com/kubernetes/community) details these things and more. - -Check out these specific resources for how to contribute to CLI: -* SIG-CLI - [How to Contribute](/sig-cli/CONTRIBUTING.md) -* Filter issue search for: `is:open is:issue label:sig/cli label:"help wanted"` -* Hand picked issues for outreachy applications: https://github.com/kubernetes/kubectl/projects/3 - -## Available tasks - -Develop `kubectl create` commands to make it easy to create Kubernetes resources -Develop `kubectl set` commands to modify Kubernetes resources -Required Skills: Go -Mentor: Phillip Wittrock - -**Coordination:** - -* Paris Pittman - parispittman@google.com -* Josh Berkus -* Elsie Phillips - -The coordinators can be contacted at any time. The easiest way is to send a slack message. - -Do you have an idea for a task that is suitable for this program? Contact the mentors or coordinators! Or even better, volunteer for mentoring an intern during the work on your idea! - -## Code of Conduct -Kubernetes abides by the CNCF [Code of Conduct](https://github.com/cncf/foundation/blob/master/code-of-conduct.md). |
