Skip to content

Commit c788309

Browse files
Add missing information in README.md
1 parent 72340f4 commit c788309

File tree

2 files changed

+18
-6
lines changed

2 files changed

+18
-6
lines changed

README.md

+18-6
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,19 @@
22

33
Kubernetes multi-tenant operator. Enables multi-tenant capabilities in your Kubernetes Cluster.
44

5+
![Logo](docs/logo.png)
6+
7+
------
8+
59
## Features
610

711
The main features included in the Operator:
812

913
- **Enable Multi-Tenant:** Adds three new hierarchy concepts *(Organizations, Tenants and Spaces)*.
1014
- **Secure and scalable cluster management delegation:** Cluster Admins creates Organizations
1115
then delegating its access to users and groups.
12-
- **Cluster budget management:** Assignning resources in the organization definition makes possible to
13-
understand how many resources are allocated to a user, team or the whole company.
16+
- **Cluster budget management:** Assigning resources in the organization definition makes possible to
17+
understand how many resources are allocated to a user, team, or the whole company.
1418

1519
## Concepts
1620

@@ -21,8 +25,8 @@ can set compute quotas for the whole Organization and grant permissions to users
2125
- **Tenant**: A tenant can be created by an Organization administrator hosting **spaces**. The Tenant administrator
2226
can fix compute quotas and assign roles to users and/or groups. Tenants resources should fit into
2327
Organization resources.
24-
- **Space**: Tenant administrator can create Spaces. An space is an abstraction layer on top of
25-
a Namespace. A tenant administrator should assign quotas and roles to the Space. Space resources should fit
28+
- **Space**: Tenant administrators can create Spaces. Space is an abstraction layer on top of
29+
a Namespace. A tenant administrator should assign quotas and roles to Space. Space resources should fit
2630
into Tenant resources.
2731

2832
## TL;DR
@@ -53,7 +57,7 @@ $ kubectl apply -f example-cr/space-1.yaml
5357
space.k8spin.cloud/dev created
5458
```
5559

56-
As cluster admin check organizations:
60+
As cluster-admin check organizations:
5761

5862
```bash
5963
$ kubectl get org
@@ -92,7 +96,7 @@ $ kubectl run nginx --image nginx --replicas=2 -n org-example-tenant-crm-space-d
9296
pod/nginx created
9397
```
9498

95-
Dicover workloads in the dev space as space viewer:
99+
Discover workloads in the dev space as space viewer:
96100

97101
```bash
98102
$ kubectl get pods -n org-example-tenant-crm-space-dev --as Pau
@@ -103,3 +107,11 @@ nginx 1/1 Running 0 66s
103107
## Documentation
104108

105109
Discover all the power of this operator [reading all the documentation](docs)
110+
111+
## Contributing
112+
113+
We would love you to contribute to `@k8spin/k8spin-operator`, pull requests are welcome! Please see the [CONTRIBUTING.md](CONTRIBUTING.md) for more information.
114+
115+
## License
116+
117+
The scripts and documentation in this project are released under the [GNU GPLv3](LICENSE)

docs/logo.png

32.1 KB
Loading

0 commit comments

Comments
 (0)