...

Text file src/k8s.io/component-base/README.md

Documentation: k8s.io/component-base

     1## component-base
     2
     3## Purpose
     4
     5Implement KEP 32: https://github.com/kubernetes/enhancements/blob/master/keps/sig-cluster-lifecycle/wgs/783-component-base/README.md
     6
     7The proposal is essentially about refactoring the Kubernetes core package structure in a way that all core components may share common code around:
     8 - ComponentConfig implementation
     9 - flag and command handling
    10 - HTTPS serving
    11 - delegated authn/z
    12 - logging.
    13
    14## Compatibility
    15
    16There are *NO compatibility guarantees* for this repository, yet.  It is in direct support of Kubernetes, so branches
    17will track Kubernetes and be compatible with that repo.  As we more cleanly separate the layers, we will review the
    18compatibility guarantee. We have a goal to make this easier to use in the future.
    19
    20
    21## Where does it come from?
    22
    23This repository is synced from https://github.com/kubernetes/kubernetes/blob/master/staging/src/k8s.io/component-base.
    24Code changes are made in that location, merged into `k8s.io/kubernetes` and later synced here.
    25
    26## Things you should *NOT* do
    27
    28 1. Directly modify any files in this repo. Those are driven from `k8s.io/kubernetes/staging/src/k8s.io/component-base`.
    29 2. Expect compatibility. This repo is changing quickly in direct support of Kubernetes.
    30
    31### OWNERS
    32
    33WG Component Standard is working on this refactoring process, which is happening incrementally, starting in the v1.14 cycle.
    34SIG API Machinery and SIG Cluster Lifecycle owns the code.
    35

View as plain text