Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
oussamarouabah committed May 14, 2024
1 parent ac31b19 commit b99979b
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 9 deletions.
10 changes: 3 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ spec:
value: "vsan-default"
- name : CHECK_STORAGE_IGNORED_CHECK_NODES
value: "node4"
image: chrishirsch/kuberhealthy-storage-check:v0.0.2
image: ghcr.io/thg-ice/kuberhealthy-storage-check:v0.0.1
imagePullPolicy: IfNotPresent
name: main
resources:
Expand Down Expand Up @@ -185,18 +185,18 @@ roleRef:
subjects:
- kind: ServiceAccount
name: storage-sa

```
#### Install
To use the *Storage Check* with Kuberhealthy, apply the configuration file [storage-check.yaml](storage-check.yaml) to your Kubernetes Cluster. The following command will also apply the configuration file to your current context:
`kubectl apply -f https://raw.githubusercontent.com/ChrisHirsch/kuberhealthy-storage-check/master/deploy/storage-check.yaml`
`kubectl apply -f https://raw.githubusercontent.com/thg-ice/kuberhealthy-storage-check/main/deploy/storage-check.yaml`

Make sure you are using the latest release of Kuberhealthy 2.0.0 or later.

The check configuration file contains:

- KuberhealthyCheck
- Role
- Rolebinding
Expand All @@ -205,7 +205,3 @@ The check configuration file contains:
- ServiceAccount

The role, rolebinding, clusterrole, clusterrolebinding and service account are all required to create and delete all PVCs and jobs from the check in the given namespaces you install the check for. The assumed default service account does not provide enough permissions for this check to run.


![Go](https://github.com/ChrisHirsch/kuberhealthy-storage-check/workflows/Go/badge.svg)
![Run Gosec](https://github.com/ChrisHirsch/kuberhealthy-storage-check/workflows/Run%20Gosec/badge.svg)
2 changes: 1 addition & 1 deletion deploy/storage-check-vsphere.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ spec:
value: "9m"
- name: MAX_FAILURES_ALLOWED
value: "9"
image: chrishirsch/kuberhealthy-storage-check:v0.0.1
image: ghcr.io/thg-ice/kuberhealthy-storage-check:v0.0.1
imagePullPolicy: IfNotPresent
name: main
resources:
Expand Down
2 changes: 1 addition & 1 deletion deploy/storage-check.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ spec:
timeout: 10m
podSpec:
containers:
- image: chrishirsch/kuberhealthy-storage-check:v0.0.1
- image: ghcr.io/thg-ice/kuberhealthy-storage-check:v0.0.1
imagePullPolicy: IfNotPresent
name: main
resources:
Expand Down

0 comments on commit b99979b

Please sign in to comment.