Skip to content

Commit

Permalink
Add warning to the user Readme file (#209)
Browse files Browse the repository at this point in the history
* Add warning to the user Readme file

* Fix sidebar

* Fix titles
  • Loading branch information
grego952 authored Sep 25, 2024
1 parent f0db361 commit cb891cc
Show file tree
Hide file tree
Showing 4 changed files with 7 additions and 4 deletions.
3 changes: 3 additions & 0 deletions docs/user/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@

## What is the Docker Registry Module?

> [!WARNING]
> Do not use Docker Registry in production clusters, where a full-fledged, highly-available, production-grade registry is necessary.
The Docker Registry module is a Kubernetes operator that adds the Docker Registry capability to a Kubernetes cluster. It installs packaged distribution images and configures them to be easily used in Kyma runtime.

## What is Docker Registry in Kyma?
Expand Down
4 changes: 2 additions & 2 deletions docs/user/_sidebar.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
- [Docker Registry Module Configuration](/docker-registry/user/00-20-configure-docker-registry.md)
- [Docker Registry Storage Configuration](/docker-registry/user/00-30-storage-configuration.md)
- [Tutorials](/docker-registry/user/tutorials/README.md)
- [Docker Registry Configuration](/docker-registry/user/tutorials/00-20-configure-docker-registry.md)
- [Registry Storage Configuration](/docker-registry/user/tutorials/00-30-storage-configuration.md)
- [Use Docker Registry Internally](/docker-registry/user/tutorials/01-10-use-registry-internally.md)
- [Expose Docker Registry](/docker-registry/user/tutorials/01-20-expose-registry.md)
- [Resources](/docker-registry/user/resources/README.md)
- [Docker Registry Custom Resource](/docker-registry/user/resources/06-20-docker-registry-cr.md)
-
2 changes: 1 addition & 1 deletion docs/user/tutorials/01-10-use-registry-internally.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Use Registry Internally
# Use Docker Registry Internally

This tutorial shows how you can push an image to the Docker Registry and use it.

Expand Down
2 changes: 1 addition & 1 deletion docs/user/tutorials/01-20-expose-registry.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Expose Registry
# Expose Docker Registry

This tutorial shows how you can expose the registry to the outside of the cluster with Istio.

Expand Down

0 comments on commit cb891cc

Please sign in to comment.