Skip to content

Commit 9a4460e

Browse files
authored
Update README.md
1 parent c922be8 commit 9a4460e

File tree

1 file changed

+3
-111
lines changed

1 file changed

+3
-111
lines changed

README.md

+3-111
Original file line numberDiff line numberDiff line change
@@ -1,114 +1,6 @@
11
# juicefs-cache-group-operator
2-
// TODO(user): Add simple overview of use/purpose
32

4-
## Description
5-
// TODO(user): An in-depth paragraph about your project and overview of use
6-
7-
## Getting Started
8-
9-
### Prerequisites
10-
- go version v1.22.0+
11-
- docker version 17.03+.
12-
- kubectl version v1.11.3+.
13-
- Access to a Kubernetes v1.11.3+ cluster.
14-
15-
### To Deploy on the cluster
16-
**Build and push your image to the location specified by `IMG`:**
17-
18-
```sh
19-
make docker-build docker-push IMG=<some-registry>/juicefs-cache-group-operator:tag
20-
```
21-
22-
**NOTE:** This image ought to be published in the personal registry you specified.
23-
And it is required to have access to pull the image from the working environment.
24-
Make sure you have the proper permission to the registry if the above commands don’t work.
25-
26-
**Install the CRDs into the cluster:**
27-
28-
```sh
29-
make install
30-
```
31-
32-
**Deploy the Manager to the cluster with the image specified by `IMG`:**
33-
34-
```sh
35-
make deploy IMG=<some-registry>/juicefs-cache-group-operator:tag
36-
```
37-
38-
> **NOTE**: If you encounter RBAC errors, you may need to grant yourself cluster-admin
39-
privileges or be logged in as admin.
40-
41-
**Create instances of your solution**
42-
You can apply the samples (examples) from the config/sample:
43-
44-
```sh
45-
kubectl apply -k config/samples/
46-
```
47-
48-
>**NOTE**: Ensure that the samples has default values to test it out.
49-
50-
### To Uninstall
51-
**Delete the instances (CRs) from the cluster:**
52-
53-
```sh
54-
kubectl delete -k config/samples/
55-
```
56-
57-
**Delete the APIs(CRDs) from the cluster:**
58-
59-
```sh
60-
make uninstall
61-
```
62-
63-
**UnDeploy the controller from the cluster:**
64-
65-
```sh
66-
make undeploy
67-
```
68-
69-
## Project Distribution
70-
71-
Following are the steps to build the installer and distribute this project to users.
72-
73-
1. Build the installer for the image built and published in the registry:
74-
75-
```sh
76-
make build-installer IMG=<some-registry>/juicefs-cache-group-operator:tag
77-
```
78-
79-
NOTE: The makefile target mentioned above generates an 'install.yaml'
80-
file in the dist directory. This file contains all the resources built
81-
with Kustomize, which are necessary to install this project without
82-
its dependencies.
83-
84-
2. Using the installer
85-
86-
Users can just run kubectl apply -f <URL for YAML BUNDLE> to install the project, i.e.:
87-
88-
```sh
89-
kubectl apply -f https://raw.githubusercontent.com/<org>/juicefs-cache-group-operator/<tag or branch>/dist/install.yaml
90-
```
91-
92-
## Contributing
93-
// TODO(user): Add detailed information on how you would like others to contribute to this project
94-
95-
**NOTE:** Run `make help` for more information on all potential `make` targets
96-
97-
More information can be found via the [Kubebuilder Documentation](https://book.kubebuilder.io/introduction.html)
98-
99-
## License
100-
101-
Copyright 2024.
102-
103-
Licensed under the Apache License, Version 2.0 (the "License");
104-
you may not use this file except in compliance with the License.
105-
You may obtain a copy of the License at
106-
107-
http://www.apache.org/licenses/LICENSE-2.0
108-
109-
Unless required by applicable law or agreed to in writing, software
110-
distributed under the License is distributed on an "AS IS" BASIS,
111-
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
112-
See the License for the specific language governing permissions and
113-
limitations under the License.
3+
JuiceFS enterprise users can use the Cache Group Operator to create and manage distributed cache clusters. Compared to other deployment methods, the Cache Group Operator is more convenient to use (supporting both GUI and CLI) and also supports advanced features such as different node configurations, smooth scaling, and automatic cache cleaning.
1144

5+
- [Document](https://juicefs.com/docs/csi/guide/cache-group-operator/)
6+
- [文档](https://juicefs.com/docs/zh/csi/guide/cache-group-operator/)

0 commit comments

Comments
 (0)