Conversation
izmalk
left a comment
izmalk
left a comment
There was a problem hiding this comment.
Nicely done! I've added a few suggestions but mostly formatting. How-to guide can be improved a bit, but nothing critical.
| @@ -0,0 +1,68 @@ | |||
| # How to disable TLS | |||
There was a problem hiding this comment.
I'm a bit surprised to see a How to disable TLS guide =).
Question: Is there a chance we can just add it as a section to the How to Enable TLS guide? It is quite small. The only reason I can think of to keep it separate is to boost its visibility and discoverability.
|
|
||
| To disable the client-to-server communication, run: | ||
|
|
||
| ```text |
There was a problem hiding this comment.
Question: Are you sure you want to use the text here? It's fine; it just disables syntax highlighting.
| $ valkey-cli -h 10.1.44.126 -p 6379 | ||
| 10.1.44.126:6379> ping | ||
| (error) NOAUTH Authentication required. |
There was a problem hiding this comment.
Suggestion: Let's avoid using prompts in the code blocks. The best practice is to either use the terminal block or separate input from output and not use prompts.
| $ valkey-cli -h 10.1.44.126 -p 6379 | |
| 10.1.44.126:6379> ping | |
| (error) NOAUTH Authentication required. | |
| valkey-cli -h 10.1.44.126 -p 6379 | |
| ``` | |
| You should see an authentication error as the result since the newtork connection was established, but no credentials provided: | |
| ```text | |
| ping | |
| (error) NOAUTH Authentication required. | |
| ``` |
| charm as an example for all cases. | ||
|
|
||
| ```{caution} | ||
| **[Self-signed certificates](https://en.wikipedia.org/wiki/Self-signed_certificate) are not recommended for a production environment.** |
There was a problem hiding this comment.
Praise: It's great that you have this warning.
| ```{caution} | ||
| **[Self-signed certificates](https://en.wikipedia.org/wiki/Self-signed_certificate) are not recommended for a production environment.** | ||
|
|
||
| Check [this guide](https://charmhub.io/topics/security-with-x-509-certificates) for an overview of all the TLS certificates charms available. |
There was a problem hiding this comment.
Suggestion: Let's avoid using the word this in links if possible.
| Check [this guide](https://charmhub.io/topics/security-with-x-509-certificates) for an overview of all the TLS certificates charms available. | |
| Check the [Security with X.509 certificates](https://charmhub.io/topics/security-with-x-509-certificates) page for an overview of all the TLS certificates charms available. |
| This hands-on tutorial aims to help you learn how to deploy Charmed Valkey and | ||
| become familiar with its available operations. | ||
|
|
||
| ## Prerequisites |
There was a problem hiding this comment.
Note: I was expecting to see some software and/or hardware requirements here. If there are any, consider adding them here. For example: CPU, RAM, Disk, Ubuntu version, etc. Non-blocking for sure.
| previously retrieved credentials: | ||
|
|
||
| ```text | ||
| 10.1.44.126:6379> AUTH charmed-operator <your-password-here> |
There was a problem hiding this comment.
Chore: Please make sure to fix code blocks (input/output combinations and cli prompts).
| ``` | ||
|
|
||
| Now it is possible to perform Valkey commands on the database. To set a key `mykey` | ||
| to the value `HelloWorld`, run this command: |
There was a problem hiding this comment.
Suggestion: Wording improvement - deleting redundancy.
| to the value `HelloWorld`, run this command: | |
| to the value `HelloWorld`: |
| @@ -0,0 +1,86 @@ | |||
| ## Valkey operator | |||
| [](https://charmhub.io/valkey) | |||
| [](https://canonical-charmed-valkey.readthedocs-hosted.com/) | |||
There was a problem hiding this comment.
Todo: Please fix the docs badge. You can use this as an example: https://github.com/canonical/spark-k8s-bundle/blob/main/README.md?plain=1#L5
| key-value data store compatible with Redis® clients and ecosystem tooling. | ||
|
|
||
| The charm can be deployed on Kubernetes and VM clouds and aims to simplify Valkey | ||
| operations from Day 0 to Day 2, offering secure defaults integration interfaces, |
There was a problem hiding this comment.
Suggestion: Do you want to add a link here?
| operations from Day 0 to Day 2, offering secure defaults integration interfaces, | |
| operations from [Day 0 to Day 2](https://codilime.com/blog/day-0-day-1-day-2-the-software-lifecycle-in-the-cloud-age/), offering secure defaults integration interfaces, |
2 participants
This PR adds the initial set of user-facing documentation: