dapr
/
kubernetes-operator
mirror of https://github.com/dapr/kubernetes-operator.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

fix(docs): minor improvements in README.md 

- `!!! info` section about manual installation changed to properly rendered [!IMPORTANT] block
- and some typos :)

Signed-off-by: Bartosz Majsak <bartosz.majsak@gmail.com>
This commit is contained in:
Bartosz Majsak 2024-06-21 13:52:17 +02:00 committed by bartoszmajsak
parent ebe7221160
commit 357ecbcccb
No known key found for this signature in database
GPG Key ID: 76A12675F652DA1C
1 changed files with 6 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
README.md
View File

@ -15,7 +15,7 @@ following methods are provided for installing the operator.
### OpenShift
The operator is published as part of the built-in Community Operators in the Operator Hub on OpenShift 4. See the
[OpenShift Install Guide][install_openshift] for more information on installing on the OpenShift platorm.
[OpenShift Install Guide][install_openshift] for more information on installing on the OpenShift platform.
### Operator Lifecycle Manager
@ -29,9 +29,8 @@ Look at the [OLM Install Guide][install_olm] for an example using this approach
The operator can be installed manually if desired.
!!! info
The manual installation method requires cluster credentials that provide the `cluster-admin` ClusterRole or
equivalent.
> [!IMPORTANT]
> The manual installation method requires cluster credentials that provide the `cluster-admin` ClusterRole or equivalent.
The [Manual Installation Guide][install_manual] provides the steps needed to manually install the operator on any
Kubernetes cluster.
@ -58,7 +57,7 @@ This means that the same configuration option that are available when [installin
When something changes on an existing `DaprControlPlane` resource or any resource generated by the operator, the operator works to reconfigure the cluster to ensure the actual state of the cluster matches the desired state.
> [!IMPORTANT]
> The operator expect that a single `DaprControlPlane` named `dapr-control-plane` and placed in the same namespace where the operator runs exists in a given point in time.
> The operator expect that a single `DaprControlPlane` named `dapr-control-plane` and placed in the same namespace where the operator runs exists at a given point in time.
> Any additional `DaprControlPlane` resources will be moved to an `Error` state and ignored.
The `DaprControlPlane` Custom Resource consists of the following properties
@ -83,7 +82,7 @@ Create a new Dapr Control Plane operator in the `openshift-operators` namespace
kubectl apply -n openshift-operators -f config/samples/basic/dapr-basic.yaml
```
There will be several Dapr controllers and resources created that should be familiar to anyone who has deployed Dapr beforeusing [helm](https://docs.dapr.io/operations/hosting/kubernetes/kubernetes-deploy/#install-with-helm-advanced):
There will be several Dapr controllers and resources created that should be familiar to anyone who has deployed Dapr before using [helm](https://docs.dapr.io/operations/hosting/kubernetes/kubernetes-deploy/#install-with-helm-advanced):
```bash
➜ kubecto tree daprcontrolplanes.operator.dapr.io dapr-control-plane
@ -125,4 +124,4 @@ openshift-operators ├─ServiceAccount/dapr-placement
openshift-operators ├─ServiceAccount/dapr-sentry - 67s
openshift-operators └─StatefulSet/dapr-placement-server - 67s
openshift-operators └─ControllerRevision/dapr-placement-server-6cb96b4b85 - 67s
```
```