k8s.io/registry.k8s.io@v0.3.1/README.md (about)

     1  # registry.k8s.io
     2  
     3  This project implements the backend for registry.k8s.io, Kubernetes's container
     4  image registry.
     5  
     6  Known user-facing issues will be pinned at the top of [our issue tracker][issues].
     7  
     8  For details on the implementation see [cmd/archeio](./cmd/archeio/README.md)
     9  
    10  The community deployment configs are documented at in the k8s.io repo with
    11  the rest of the community infra deployments, but primarily 
    12  [here][infra-configs].
    13  
    14  For publishing to registry.k8s.io, refer to [the docs][publishing] at in k8s.io 
    15  under `registry.k8s.io/`.
    16  
    17  ## Stability
    18  
    19  registry.k8s.io is GA and we ask that all users migrate from k8s.gcr.io as
    20  soon as possible.
    21  
    22  However, unequivocally: **DO NOT depend on the implementation details of this registry.**
    23  
    24  **Please note that there is NO uptime SLA as this is a free, volunteer managed
    25  service**. We will however do our best to respond to issues and the system is
    26  designed to be reliable and low-maintenance. If you need higher uptime guarantees
    27  please consider [mirroring] images to a location you control.
    28  
    29  **Other than `registry.k8s.io` serving an [OCI][distribution-spec] compliant registry:
    30  API endpoints, IP addresses, and backing services used 
    31  are subject to change at _anytime_ as new resources become available or as otherwise
    32  necessary.**
    33  
    34  **If you need to allow-list domains or IPs in your environment, we highly recommend
    35  [mirroring] images to a location you control instead.**
    36  
    37  The Kubernetes project is currently sending traffic to GCP and AWS
    38  thanks to their donations but we hope to redirect traffic to more
    39  sponsors and their respective API endpoints in the future to keep the project
    40  sustainable.
    41  
    42  See Also:
    43  - Pinned issues in our [our issue tracker][issues]
    44  - Our [debugging guide][debugging] for identifying and resolving or reporting issues
    45  - Our [mirroring guide][mirroring] for how to mirror and use mirrored Kubernetes images
    46  
    47  ## Privacy
    48  
    49  This project abides by the Linux Foundation privacy policy, as documented at
    50  https://registry.k8s.io/privacy
    51  
    52  ## Background
    53  
    54  Previously all of Kubernetes' image hosting has been out of gcr.io ("Google Container Registry").
    55  
    56  We've incurred significant egress traffic costs from users on other cloud providers
    57  in particular in doing so, severely limiting our ability to use the 
    58  GCP credits from Google for purposes other than hosting end-user downloads.
    59  
    60  We're now moving to shift all traffic behind a community controlled domain, so
    61  we can quickly implement cost-cutting measures like serving the bulk of the traffic
    62  for AWS-users from AWS-local storage funded by Amazon, or potentially leveraging
    63  other providers in the future.
    64  
    65  For additional context on why we did this and what we're changing about kubernetes images
    66  see: https://kubernetes.io/blog/2022/11/28/registry-k8s-io-faster-cheaper-ga
    67  
    68  Essentially, this repo implements the backend sources for the steps outlined there.
    69  
    70  For a talk with more details see: ["Why We Moved the Kubernetes Image Registry"](https://www.youtube.com/watch?v=9CdzisDQkjE)
    71  
    72  ## Community, discussion, contribution, and support
    73  
    74  Learn how to engage with the Kubernetes community on the [community page](http://kubernetes.io/community/).
    75  
    76  You can reach the maintainers of this project at:
    77  
    78  - [Slack](http://slack.k8s.io/) in channel `#sig-k8s-infra`
    79  - [Mailing List](https://groups.google.com/forum/#!forum/kubernetes-sig-k8s-infra)
    80  
    81  ### Code of conduct
    82  
    83  Participation in the Kubernetes community is governed by the [Kubernetes Code of Conduct](code-of-conduct.md).
    84  
    85  [owners]: https://git.k8s.io/community/contributors/guide/owners.md
    86  [Creative Commons 4.0]: https://git.k8s.io/website/LICENSE
    87  [distribution-spec]: https://github.com/opencontainers/distribution-spec
    88  [publishing]: https://git.k8s.io/k8s.io/registry.k8s.io#managing-kubernetes-container-registries
    89  [infra-configs]: https://github.com/kubernetes/k8s.io/tree/main/infra/gcp/terraform
    90  [mirroring]: ./docs/mirroring/README.md
    91  [debugging]: ./docs/debugging.md
    92  [issues]: https://github.com/kubernetes/registry.k8s.io/issues