Skip to content

Commit

Permalink
update: README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
amirhnajafiz committed Nov 4, 2023
1 parent 8448084 commit 5678cb4
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Sanjab
# :chipmunk: Sanjab

![GitHub release (with filter)](https://img.shields.io/github/v/release/amirhnajafiz/sanjab)
![GitHub top language](https://img.shields.io/github/languages/top/amirhnajafiz/sanjab)
Expand All @@ -22,7 +22,7 @@ as a yaml file on Ceph cluster.
- Ingress
- PVCs

## configs
## :evergreen_tree: configs

For Sanjab server configs, you need to create a ```config.yml``` file. This file's structure
is like this:
Expand All @@ -49,19 +49,19 @@ resources:
- deployments
```

## deployment
## :tent: deployment

To deploy Sanjab on a kubernetes cluster, review deployment manifests. You need to deploy
all of those files, especially ```rbac``` and ```service account```. Sanjab needs access
to all api groups in order to get, list, and watch those resources.

### docker image
### :peanuts: docker image

````shell
docker pull amirhossein21/sanjab:latest
````

## monitor
## :rotating_light: monitoring

If you want to check Sanjab health and workers status, make the following http
requests.
Expand Down

0 comments on commit 5678cb4

Please sign in to comment.