Migrate the remaining content out of the wiki
I anticipate much of this is obsolete or outdated. I outright deleted content for which I knew this to be the case. What remains is content I don't have direct knowledge of or control over. If you would rather I just delete it than dump in your SIG's directory, please speak up
This commit is contained in:
Aaron Crickenberger
parent
309b27fa95
commit
3a71b4ce20
|
|
@ -0,0 +1 @@
|
|||
The content in here has been migrated from https://github.com/kubernetes/community/wiki and is likely severely out of date. Please contact this SIG if you have questions or ideas about where this content should go.
|
||||
|
|
@ -0,0 +1,64 @@
|
|||
# Client Tool Release Publishing Guidelines
|
||||
|
||||
Projects should publish releases for client side tools.
|
||||
|
||||
## Go Projects
|
||||
|
||||
### Static Linking
|
||||
|
||||
See [Go executables are statically linked, except when they are not](http://matthewkwilliams.com/index.php/2014/09/28/go-executables-are-statically-linked-except-when-they-are-not/).
|
||||
|
||||
|
||||
- How to compile a statically linked binary: `go` file must be compiled without cgo support.
|
||||
|
||||
```sh
|
||||
# Disable cgo
|
||||
export CGO_ENABLED=0
|
||||
```
|
||||
|
||||
- How to check if a binary is statically linked
|
||||
|
||||
```sh
|
||||
# List dynamic dependencies (shared libraries):
|
||||
# 1. if it's dynamically linked, you'll see
|
||||
$ ldd <your_tool>
|
||||
linux-vdso.so.1 => (0x00007ffe937ea000)
|
||||
libpthread.so.0 => /lib/x86_64-linux-gnu/libpthread.so.0 (0x00007f0a7dae5000)
|
||||
libc.so.6 => /lib/x86_64-linux-gnu/libc.so.6 (0x00007f0a7d720000)
|
||||
/lib64/ld-linux-x86-64.so.2 (0x00007f0a7dd03000)
|
||||
# 2. if it's statically linked, you'll see
|
||||
$ ldd <your_tool>
|
||||
not a dynamic executable
|
||||
|
||||
# Recognize the type of data in a file
|
||||
# 1. if it's dynamically linked, you'll see
|
||||
$ file <your_tool>
|
||||
/usr/local/your_tool: ELF 64-bit LSB executable, x86-64, version 1 (SYSV), dynamically linked (uses shared libs), for GNU/Linux 2.6.32, BuildID[sha1]=86c6d2ff21297a06cc7319244f35e2671612beae, not stripped
|
||||
# 2. if it's statically linked, you'll see
|
||||
$ file <your_tool>
|
||||
/usr/local/your_tool: ELF 64-bit LSB executable, x86-64, version 1 (SYSV), statically linked, not stripped
|
||||
```
|
||||
|
||||
### Targets
|
||||
Build your release binary for the following targets:
|
||||
|
||||
- darwin-amd64
|
||||
- linux-386
|
||||
- linux-amd64
|
||||
- linux-armv6l
|
||||
- linux-ppc64le
|
||||
- windows-amd64
|
||||
|
||||
### Packaging
|
||||
|
||||
Package binaries into a tar.gz file and make available on GitHub releases page.
|
||||
|
||||
# Service Side Release Publishing Guidelines
|
||||
|
||||
### Packaging
|
||||
|
||||
Server side programs should be packaged into container images. Stateless services should be run as Deployments (as opposed to Replication Controllers).
|
||||
|
||||
# Documentation Guidelines
|
||||
|
||||
TODO: Write this
|
||||
|
|
@ -0,0 +1,112 @@
|
|||
# kubectl roadmap
|
||||
|
||||
`kubectl` is the Kubernetes CLI.
|
||||
|
||||
If you'd like to contribute, please read the [conventions](https://github.com/kubernetes/community/blob/master/contributors/devel/kubectl-conventions.md) and familiarize yourself with [existing commands](http://kubernetes.io/docs/user-guide/kubectl-overview/).
|
||||
|
||||
**Owner:** @kubernetes/kubectl
|
||||
|
||||
**Label:** [component/kubectl](https://github.com/kubernetes/kubernetes/labels/component%2Fkubectl)
|
||||
|
||||
**Motivation:** [kubectl brainstorm](https://docs.google.com/document/d/1tPrTL5Fi8BjlIK_XwNz-W260ll2ZYflrdbtnwE1PQoE/edit?pli=1#)
|
||||
|
||||
### 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)
|
||||
* 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)
|
||||
* [`view` commands](https://github.com/kubernetes/kubernetes/issues/29679)
|
||||
* [Support `run --edit` and `create --edit`](https://github.com/kubernetes/kubernetes/issues/18064)
|
||||
* [More `kubectl create <sub-command>`](https://github.com/kubernetes/kubernetes/issues/25382)
|
||||
* [Support `--dry-run` for every mutation](https://github.com/kubernetes/kubernetes/issues/11488)
|
||||
* kubectl commands aliases
|
||||
* [Allow user defined aliases for resources and commands](https://github.com/kubernetes/kubernetes/issues/18023)
|
||||
* [Suggest possibly matching kubectl commands](https://github.com/kubernetes/kubernetes/issues/25180)
|
||||
* Improve `kubectl run`
|
||||
* Make generated objects more discoverable: suggest the user to do `kubectl get all` to see what's generated ([extend `all` to more resources](https://github.com/kubernetes/kubernetes/issues/22337))
|
||||
* [Make it optional to specify name (auto generate name from image)](https://github.com/kubernetes/kubernetes/issues/2643)
|
||||
* [Make `kubectl run --restart=Never` creates Pods (instead of Jobs)](https://github.com/kubernetes/kubernetes/issues/24533)
|
||||
* Create commands/flags for common get + template patterns (e.g. getting service IP address)
|
||||
* [Implement `kubectl cp`](https://github.com/kubernetes/kubernetes/issues/13776) to copy files between containers and local for debugging
|
||||
* `kubectl rollout`
|
||||
* [Add `kubectl rollout start` to show how to start a rollout](https://github.com/kubernetes/kubernetes/issues/25142)
|
||||
* [Add `kubectl rollout status`](https://github.com/kubernetes/kubernetes/issues/25235)
|
||||
* Scripting support
|
||||
* [wait](https://github.com/kubernetes/kubernetes/issues/1899)
|
||||
* [watch / IFTTT](https://github.com/kubernetes/kubernetes/issues/5164)
|
||||
* [Add `kubectl top`](https://github.com/kubernetes/kubernetes/issues/11382) which lists resource metrics.
|
||||
|
||||
### Alternative interfaces
|
||||
|
||||
* Create a terminal based console, ref [docker console](https://github.com/dustinlacewell/console) ([video](https://www.youtube.com/watch?v=wSzZxbDYgtY))
|
||||
* [Add `kubectl sh`, an interactive shell](https://github.com/kubernetes/kubernetes/issues/25385), or make a kubectlshell in contrib and make bash completion part of it (ref [pythonshell](https://gist.github.com/bprashanth/9a3c8dfbba443698ddd960b8087107bf))
|
||||
* Think about how/whether to invoke generation commands such as `kubectl run` or `kubectl create configmap` in bulk, declaratively, such as part of the `apply` flow.
|
||||
* [ChatOps](https://www.pagerduty.com/blog/what-is-chatops/) bot -- such as [kubebot](https://github.com/harbur/kubebot) (add to tools documentation)
|
||||
|
||||
### Improve help / error messages / output
|
||||
* Make kubectl functionality more discoverable
|
||||
* [Overhaul kubectl help](https://github.com/kubernetes/kubernetes/issues/16089)
|
||||
* ~~[Print "Usage" at the bottom](https://github.com/kubernetes/kubernetes/issues/7496)~~
|
||||
* Add keywords (critical words) to help
|
||||
* List valid resources for each command
|
||||
* Make short description of each command more concrete; use the same language for each command
|
||||
* Link to docs ([kubernetes.io/docs](http://kubernetes.io/docs))
|
||||
* [Update `kubectl help` descriptions and examples from docs](https://github.com/kubernetes/kubernetes/issues/25290)
|
||||
* Embed formatting and post-process for different media (terminal, man, github, etc.)
|
||||
* [Suppress/hide global flags](https://github.com/kubernetes/kubernetes/issues/23402)
|
||||
* ~~[Categorize kubectl commands or list them in alphabetical order]~~(https://github.com/kubernetes/kubernetes/issues/21585)
|
||||
* [Implement search in `kubectl help`](https://github.com/kubernetes/kubernetes/issues/25234)
|
||||
* [Suggest next/alternative commands](https://github.com/kubernetes/kubernetes/issues/19736)
|
||||
* [Add a verbosity flag that explains all the things that it's doing](https://github.com/kubernetes/kubernetes/issues/25272)
|
||||
* ~~[Fix incomplete kubectl bash completion](https://github.com/kubernetes/kubernetes/issues/25287)~~
|
||||
* Improve error messages (note that not all of these problems are in kubectl itself)
|
||||
* [when kubectl doesn’t know what cluster to talk to](https://github.com/kubernetes/kubernetes/issues/24420)
|
||||
* ~~[non-existent namespace produces obscure error](https://github.com/kubernetes/kubernetes/issues/15542)~~
|
||||
* [line numbers with validation errors](https://github.com/kubernetes/kubernetes/issues/12231)
|
||||
* [invalid lines with validation errors](https://github.com/kubernetes/kubernetes/issues/6132)
|
||||
* [malformed inputs produce misleading error messages](https://github.com/kubernetes/kubernetes/issues/9012)
|
||||
* [non-yaml/json produces obscure error](https://github.com/kubernetes/kubernetes/issues/8838)
|
||||
* [error messages for non-existent groups/types](https://github.com/kubernetes/kubernetes/issues/19530)
|
||||
* Suggest resource type when not provided (e.g. `kubectl get my-pod-name` should suggest running `kubectl get pod/my-pod-name`)
|
||||
* [errors for other non-existent resources](https://github.com/kubernetes/kubernetes/issues/6703)
|
||||
* [lack of apiVersion/kind produces confusing error messages](https://github.com/kubernetes/kubernetes/issues/6439)
|
||||
* [update validation errors could be more informative](https://github.com/kubernetes/kubernetes/issues/8668)
|
||||
* [field validation errors could be more helpful](https://github.com/kubernetes/kubernetes/issues/10534)
|
||||
* [field errors should use json field names](https://github.com/kubernetes/kubernetes/issues/3084)
|
||||
* [clearer error for bad image/registry](https://github.com/kubernetes/kubernetes/issues/7960)
|
||||
* [no error for illegal scale](https://github.com/kubernetes/kubernetes/issues/11148)
|
||||
* [deletion timeout doesn't provide any details](https://github.com/kubernetes/kubernetes/issues/19427)
|
||||
* [service creation timeout doesn't provide any details](https://github.com/kubernetes/kubernetes/issues/4860)
|
||||
* [create secret with invalid data has obscure error message](https://github.com/kubernetes/kubernetes/issues/10309)
|
||||
* [--all-namespaces error is unclear](https://github.com/kubernetes/kubernetes/issues/15834)
|
||||
* [exec has unclear errors](https://github.com/kubernetes/kubernetes/issues/9944)
|
||||
* [logs has misleading errors](https://github.com/kubernetes/kubernetes/issues/6376)
|
||||
* [improve error reporting by adding URLs](https://github.com/kubernetes/kubernetes/issues/5551)
|
||||
* Improve jsonpath / gotemplate error messages (it's tricky to get the path just right)
|
||||
* [error message for user with no permissions is extremely cryptic](https://github.com/kubernetes/kubernetes/issues/26909)
|
||||
* [Cleanup `kubectl get/describe` output](https://github.com/kubernetes/kubernetes/issues/20941)
|
||||
* [Clarify kubectl get/describe service output](https://github.com/kubernetes/kubernetes/issues/22702)
|
||||
* [Define and document command conventions for users](https://github.com/kubernetes/kubernetes/issues/25388)
|
||||
|
||||
### Bug fix
|
||||
* Fix [apply](https://github.com/kubernetes/kubernetes/issues?utf8=%E2%9C%93&q=is%3Aopen+label%3Acomponent%2Fkubectl+label%3Akind%2Fbug+apply), [edit](https://github.com/kubernetes/kubernetes/issues?utf8=%E2%9C%93&q=is%3Aopen+label%3Acomponent%2Fkubectl+label%3Akind%2Fbug+edit), and [validate](https://github.com/kubernetes/kubernetes/issues?utf8=%E2%9C%93&q=is%3Aopen+label%3Acomponent%2Fkubectl+label%3Akind%2Fbug+validate) bugs
|
||||
|
||||
### Installation / Release
|
||||
* `gcloud` should enable kubectl bash completion when installing `kubectl`
|
||||
* [Pipe-to-sh to install kubectl](https://github.com/kubernetes/kubernetes/issues/25386)
|
||||
* [Static build of kubectl for containers](https://github.com/kubernetes/kubernetes/issues/23708) ([we have it](https://github.com/kubernetes/kubernetes/tree/master/examples/kubectl-container), but it's not part of the release)
|
||||
|
||||
### Others
|
||||
* [Move functionality to server](https://github.com/kubernetes/kubernetes/issues/12143)
|
||||
* [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/))
|
||||
* Permanently disable warnings once displayed
|
||||
* Default labels as columns
|
||||
* Default `--record`, `--save-config`, etc.
|
||||
* [Overhaul cluster-related commands](https://github.com/kubernetes/kubernetes/issues/20605)
|
||||
* [Delete cluster from `kubectl config`](https://github.com/kubernetes/kubernetes/issues/25601)
|
||||
* ~~["kubectl-only Ubernetes": enabe kubectl to target any one of many clusters](https://github.com/kubernetes/kubernetes/issues/23492)~~
|
||||
|
|
@ -0,0 +1 @@
|
|||
The content in here has been migrated from https://github.com/kubernetes/community/wiki and is likely severely out of date. Please contact this SIG if you have questions or ideas about where this content should go.
|
||||
|
|
@ -0,0 +1,166 @@
|
|||
OBSOLETE
|
||||
|
||||
Cluster lifecycle includes deployment (infrastructure provisioning and bootstrapping Kubernetes), scaling, upgrades, and turndown.
|
||||
|
||||
Owner: @kubernetes/sig-cluster-lifecycle (kubernetes-sig-cluster-lifecycle at googlegroups.com, sig-cluster-lifecycle on slack)
|
||||
|
||||
There is no one-size-fits-all solution for cluster deployment and management (e.g., upgrades). There's a spectrum of possible solutions, each with different tradeoffs:
|
||||
* opinionated solution (easier to use for a narrower solution space) vs. toolkit (easier to adapt and extend)
|
||||
* understandability (easier to modify) vs. configurability (addresses a broader solution space without coding)
|
||||
|
||||
Some useful points in the spectrum are described below.
|
||||
|
||||
There are a number of tasks/features/changes that would be useful to multiple points in the spectrum. We should prioritize them, since they would enable multiple solutions.
|
||||
|
||||
See also:
|
||||
* [Feature-tracking issue](https://github.com/kubernetes/features/issues/11)
|
||||
* [Cluster deployment v2 issue](https://github.com/kubernetes/kubernetes/issues/23174)
|
||||
* [Shared infrastructure issue](https://github.com/kubernetes/kube-deploy/issues/123)
|
||||
* [Kube-up replacement that works for everyone](https://github.com/kubernetes/kubernetes/issues/23478)
|
||||
* https://github.com/kubernetes/kubernetes/labels/area%2Fcluster-lifecycle
|
||||
* [Deployment DX Notes](https://docs.google.com/document/d/1jAQ5H222pJzpv-m0OsezZgdhdkf299E7H8Q9yzNrAjg/edit#)
|
||||
|
||||
We need to improve support/behavior for cluster updates/upgrades, as well. TODO: make a list of open issues. Examples include [feature gating](https://github.com/kubernetes/kubernetes/issues/4855), [node upgrades](https://github.com/kubernetes/kubernetes/issues/6079), and [node draining](https://github.com/kubernetes/kubernetes/issues/6080).
|
||||
|
||||
## Single-node laptop/development cluster
|
||||
|
||||
Should be sufficient to kick the tires for most examples and for local development. Should be dead simple to use and highly opinionated rather than configurable.
|
||||
|
||||
Owner: @dlorenc
|
||||
|
||||
See also:
|
||||
* https://github.com/kubernetes/minikube
|
||||
|
||||
To do:
|
||||
* Replace single-node getting-started guides
|
||||
* [Docker single-node](http://kubernetes.io/docs/getting-started-guides/docker/)
|
||||
|
||||
## Portable multi-node cluster understandable reference implementation
|
||||
|
||||
For people who want to get Kubernetes running painlessly on an arbitrary set of machines -- any cloud provider (or bare metal), any OS distro, any networking infrastructure. Porting work should be minimized via separation of concerns (composition) and ease of modification rather than automated configuration transformation. Not intended to be highly optimized by default, but the cluster should be reliable.
|
||||
|
||||
Also a reference implementation for people who want to understand how to build Kubernetes clusters from scratch.
|
||||
|
||||
Ideally cluster scaling and upgrades would be supported by this implementation.
|
||||
|
||||
Replace [Docker multi-node guide](http://kubernetes.io/docs/getting-started-guides/docker-multinode/).
|
||||
|
||||
To facilitate this, we aim to provide an understandable, declarative, decoupled infrastructure provisioning implementation and a portable cluster bootstrapping implementation. Networking setup needs to be decoupled, so it can be swapped out with alternative implementations.
|
||||
|
||||
For portability, all components need to be containerized (though Kubelet may use an alternative to Docker, so long as it is portable and meets other requirements) and we need a default network overlay solution.
|
||||
|
||||
Eventually, we'd like to entirely eliminate the need for Chef/Puppet/Ansible/Salt. We shouldn't need to copy files around to host filesystems.
|
||||
|
||||
For simplicity, users shouldn't need to install/launch more than one component or execute more than one command per node. This could be achieved a variety of ways: monolithic binaries, monolithic containers, a launcher/controller container that spawns other containers, etc.
|
||||
|
||||
Once we have this, we should delete out-of-date, untested "getting-started guides" ([example broken cluster debugging thread](https://github.com/kubernetes/dashboard/issues/971)).
|
||||
|
||||
See also:
|
||||
* [Summary proposal](https://github.com/kubernetes/kubernetes-anywhere/blob/master/PROPOSAL.md)
|
||||
* [kubernetes-anywhere umbrella issue](https://github.com/kubernetes/kubernetes-anywhere/issues/127)
|
||||
* https://github.com/kubernetes/kubernetes/blob/master/docs/proposals/cluster-deployment.md
|
||||
* [Bootstrap API](https://github.com/kubernetes/kubernetes/issues/5754)
|
||||
* [jbeda's simple setup sketch](https://gist.github.com/jbeda/7e66965a23c40a91521cf6bbc3ebf007)
|
||||
|
||||
To do:
|
||||
* [Containerize](https://github.com/kubernetes/kubernetes/issues/246) all the components in order to achieve OS-distro independence
|
||||
* [Self-host](https://github.com/kubernetes/kubernetes/issues/18735) as much as possible, such as using Deployment, DaemonSet, [ConfigMap](https://github.com/kubernetes/kubernetes/issues/1627)
|
||||
* Eliminate the need to read configurations from local disk
|
||||
* [Dynamic Kubelet configuration](https://github.com/kubernetes/kubernetes/issues/27980)
|
||||
* [Kubelet checkpointing](https://github.com/kubernetes/kubernetes/issues/489) in order to reliably run control-plane components without static pods
|
||||
* [Run Kubelet in a container](https://github.com/kubernetes/kubernetes/issues/4869)
|
||||
* [DaemonSet updates](https://github.com/kubernetes/community/wiki/Roadmap:-DaemonSet)
|
||||
* [DaemonSet for bootstrapping](https://github.com/kubernetes/kubernetes/issues/15324)
|
||||
* [Bootkube](https://docs.google.com/document/d/1VNp4CMjPPHevh2_JQGMl-hpz9JSLq3s7HlI87CTjl-8/edit)
|
||||
* Adopt a default network overlay, but enable others to be swapped in via composition
|
||||
* Need to make it clear that this is for simplicity and portability, but isn't the only option
|
||||
* [Link etcd and the master components](https://github.com/kubernetes/kubernetes/issues/5755) into a monolithic [monokube-like](https://github.com/polvi/monokube) binary and/or [finish hyperkube](https://github.com/kubernetes/kubernetes/issues/16508)
|
||||
* [Replace multi-node Docker getting-started guide](https://github.com/kubernetes/kubernetes/issues/24114)
|
||||
* Make it easy to get the right version of Docker on major Linux distros (e.g., apt-get install...)
|
||||
* It's easy to get the wrong version: docker, docker.io, docker-engine, ...
|
||||
|
||||
Starting points:
|
||||
* https://github.com/kubernetes/kubernetes-anywhere
|
||||
* https://github.com/Capgemini/kubeform
|
||||
|
||||
## Building a cluster from scratch
|
||||
|
||||
For people starting from scratch:
|
||||
* http://kubernetes.io/docs/getting-started-guides/scratch/
|
||||
* https://github.com/kelseyhightower/kubernetes-the-hard-way
|
||||
* https://news.ycombinator.com/item?id=12022215
|
||||
|
||||
We should simplify this as much as possible, and clearly document it.
|
||||
|
||||
This is probably the only viable way to support people who want to do significant customization:
|
||||
* cloud provider (including bare metal)
|
||||
* OS distro
|
||||
* cluster size
|
||||
* master and worker node configurations
|
||||
* networking solution and parameters (e.g., CIDR)
|
||||
* container runtime (Docker or rkt) and its configuration
|
||||
* monitoring solutions
|
||||
* logging solutions
|
||||
* ingress controller
|
||||
* image registry
|
||||
* IAM
|
||||
* HA
|
||||
* multi-zone
|
||||
* K8s component configuration
|
||||
|
||||
To do:
|
||||
* Simplify release packaging and installation
|
||||
* Finding and installing the right version of Docker itself can be hard (`apt-get install docker/docker.io/docker-engine` isn't the right thing)
|
||||
* Build rpms, debs?
|
||||
* Verify that system requirements have been satisfied (docker version, kernel configuration, etc.)
|
||||
* And ideally degrade gracefully and warn if they are not
|
||||
* Documentation
|
||||
* What is the latest release, how can I find it, how do I install it, what version of Docker/rkt/etc. is required?
|
||||
* An architectural diagram (like the one we use in our presentations) would help, too.
|
||||
* Explain the architecture
|
||||
* Link to instructions about how to manage etcd
|
||||
* Link to [Chubby paper](http://static.googleusercontent.com/media/research.google.com/en//archive/chubby-osdi06.pdf)
|
||||
* Document system requirements ("Node Spec")
|
||||
* OS distro versions
|
||||
* kernel configuration
|
||||
* resources
|
||||
* IP forwarding
|
||||
* [Document how to set up a cluster](https://docs.google.com/document/d/1c4DMomZgS1i6AlKbb_8CiTcuimotkcJZAqJtQTN1iqc/edit#heading=h.58fpuhrw9g2o)
|
||||
* Adequately document how to configure our components.
|
||||
* Improve/simplify/organize command help
|
||||
* Hide/remove/deemphasize test-only options
|
||||
* Document how to integrate IAM
|
||||
* [Create guides to help with key decisions for production clusters](https://github.com/kubernetes/kubernetes/issues/10100)
|
||||
* Selecting a networking model
|
||||
* Managing a CA
|
||||
* Managing user authentication and authorization
|
||||
* Initial deployment requirements (memory, cpu, networking, storage)
|
||||
* Upgrading best practices
|
||||
* Code changes
|
||||
* Finish [converting components to use configuration files rather than command-line flags](https://github.com/kubernetes/kubernetes/issues/12245)
|
||||
* Facilitate [managing that configuration using ConfigMap](https://github.com/kubernetes/kubernetes/issues/1627)
|
||||
* [Cluster config](https://github.com/kubernetes/kubernetes/issues/19831)
|
||||
* Reduce external dependencies
|
||||
* APIs for reusable building blocks, such as [TLS bootstrap](https://github.com/kubernetes/kubernetes/issues/18112), [certificate signing for addons](https://github.com/kubernetes/kubernetes/issues/11725), [teardown](https://github.com/kubernetes/kubernetes/issues/4630)
|
||||
* Need key/cert rotation ([master](https://github.com/kubernetes/kubernetes/issues/4672), [service accounts](https://github.com/kubernetes/kubernetes/issues/20165))
|
||||
* Finish generalization of [component registration](https://github.com/kubernetes/kubernetes/pull/13216)
|
||||
* [Improve addon management](https://github.com/kubernetes/features/issues/18)
|
||||
|
||||
## Production-grade, easy-to-use cluster management tools/services
|
||||
|
||||
Easy to use and opinionated. Potentially highly optimized. Acceptable for production use. Not necessarily easily portable nor easy to extend/adapt/change.
|
||||
|
||||
Examples:
|
||||
* [Kube-AWS](https://github.com/coreos/coreos-kubernetes/tree/master/multi-node/aws)
|
||||
* [kops](https://github.com/kubernetes/kops)
|
||||
* [Kargo](https://github.com/kubespray/kargo)
|
||||
* (is https://github.com/kubernetes/contrib/tree/master/ansible still needed?)
|
||||
* [kompose8](https://github.com/digitalrebar/kompos8)
|
||||
* [Tectonic](https://tectonic.com/)
|
||||
* [Kraken](https://github.com/samsung-cnct/kraken)
|
||||
* [NavOps Launch](https://www.navops.io/launch.html)
|
||||
* [Photon Cluster Manager](https://github.com/vmware/photon-controller/tree/master/java/cluster-manager)
|
||||
* [Platform 9](https://platform9.com/blog/containers-as-a-service-kubernetes-docker/)
|
||||
* [GKE](https://cloud.google.com/container-engine/)
|
||||
* [Stackpoint.io](https://stackpoint.io/)
|
||||
* [Juju](https://jujucharms.com/canonical-kubernetes)
|
||||
|
|
@ -0,0 +1,47 @@
|
|||
<!---
|
||||
This is an autogenerated file!
|
||||
|
||||
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 SIG
|
||||
|
||||
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.
|
||||
|
||||
## Meetings
|
||||
* [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).
|
||||
|
||||
Meeting notes and Agenda can be found [here](https://docs.google.com/document/d/1r0YElcXt6G5mOWxwZiXgGu_X6he3F--wKwg-9UBc29I/edit?usp=sharing).
|
||||
Meeting recordings can be found [here](https://www.youtube.com/playlist?list=PL69nYSiGNLP28HaTzSlFe6RJVxpFmbUvF).
|
||||
|
||||
## Leads
|
||||
* Fabiano Franz (**[@fabianofranz](https://github.com/fabianofranz)**), Red Hat
|
||||
* Phillip Wittrock (**[@pwittrock](https://github.com/pwittrock)**), Google
|
||||
* Tony Ado (**[@AdoHe](https://github.com/AdoHe)**), Alibaba
|
||||
|
||||
## Contact
|
||||
* [Slack](https://kubernetes.slack.com/messages/sig-cli)
|
||||
* [Mailing list](https://groups.google.com/forum/#!forum/kubernetes-sig-cli)
|
||||
* [Open Community Issues/PRs](https://github.com/kubernetes/community/labels/sig%2Fcli)
|
||||
|
||||
## 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.
|
||||
|
||||
| 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 -->
|
||||
|
||||
<!-- END CUSTOM CONTENT -->
|
||||
|
|
@ -0,0 +1,12 @@
|
|||
*Or, one weird trick to make Reviewable awesome*
|
||||
|
||||
The Kubernetes team is still new to _Reviewable_. As you discover new cool features and workflows, add them here. Once we have built up a good number of tricks we can reorganize this list.
|
||||
|
||||
- Hold off on publishing comments (using the "Publish" button) until you have completed your review. [(source)](@pwittrock)
|
||||
- When leaving comments, select a "disposition" (the button with your profile picture) to indicate whether the comment requires resolution, or is just advisory and hence requires no response. [(source)](@pwittrock)
|
||||
- Change a comment's "disposition" to "close" those to which the author didn't respond explicitly but did address with satisfactory changes to the code. Otherwise, the comment hangs out there awaiting a response; in contrast to GitHub's review system, _Reviewable_ doesn't consider a change to the target line to be a sufficient indicator of resolution or obsolescence, which is a safer design. Use the <kbd>y</kbd> to acknowledge the current comment, which indicates that no further response is necessary.
|
||||
- To "collapse" a whole file in the multi-file view, click the rightmost value in the revision range control. This is effectively saying, "Show no diffs."
|
||||
- Use the red/green "eye" icon to indicate completion of and to keep track of which files you have reviewed. The <kbd>x</kbd> keyboard shortcut toggles the completion status of the file currently focused in the status bar across the top.
|
||||
- Use the <kbd>p</kbd> and <kbd>n</kbd> keys to navigate to the previous and next unreviewed file—that is, those whose status is a red circle with a crossed white eye icon, meaning incomplete, as opposed to those with a green circle with a white eye, meaning complete.
|
||||
- Use the <kbd>j</kbd> and <kbd>k</kbd> keys to navigate to the previous and next comment. Use <kbd>S-j</kbd> and <kbd>S-k</kbd> to navigate between the previous and next _unaddressed_ comment. Usually as the reviewer, you use the latter to go back and check on whether your previous suggestions were addressed.
|
||||
- Reply with `+lgtm` to apply the "LGTM" label directly from _Reviewable_.
|
||||
|
|
@ -0,0 +1 @@
|
|||
The content in here has been migrated from https://github.com/kubernetes/community/wiki and is likely severely out of date. Please contact this SIG if you have questions or ideas about where this content should go.
|
||||
|
|
@ -0,0 +1,15 @@
|
|||
# Docs and examples roadmap
|
||||
|
||||
If you'd like to help with documentation, please read the [kubernetes.io site instructions](https://github.com/kubernetes/kubernetes.github.io/blob/master/README.md).
|
||||
|
||||
If you'd like to contribute an example, please read the [guidelines](https://github.com/kubernetes/kubernetes/blob/master/examples/guidelines.md).
|
||||
|
||||
Owners: @kubernetes/docs, @kubernetes/examples
|
||||
|
||||
Labels: [kind/documentation](https://github.com/kubernetes/kubernetes/issues?q=is%3Aopen+is%3Aissue+label%3Akind%2Fdocumentation), [kind/example](https://github.com/kubernetes/kubernetes/issues?q=is%3Aopen+is%3Aissue+label%3Akind%2Fexample)
|
||||
|
||||
We're currently planning a documentation site overhaul. Join kubernetes-dev@googlegroups.com to gain access to the proposals.
|
||||
|
||||
* [Overhaul proposal](https://docs.google.com/document/d/12Nfj2E8tZL-CMnnpkSH9m5k_oqd4qJh4qDwYDxPGJJI/edit?ts=5705b1fc#)
|
||||
* [Mocks](https://docs.google.com/presentation/d/14mJwJGlwBJHIpMRGR-nYMSyyNk-kRpabyz74-YYXeTo/edit#slide=id.g12d21f53ed_2_11)
|
||||
* [API documentation improvements](https://github.com/kubernetes/kubernetes/issues/19680)
|
||||
Loading…
Reference in New Issue