Skip to content

Commit a90df68

Browse files
committed
docs: add kubelinter command
1 parent ccd1c1d commit a90df68

File tree

1 file changed

+16
-3
lines changed

1 file changed

+16
-3
lines changed

README.md

Lines changed: 16 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,25 +7,32 @@ Group course project of a self service and kitchen management system for a ficti
77
Requirements: Local Kubernetes cluster, kubectl
88

99
1. Clone and navigate to this repository:
10-
```
10+
11+
```bash
1112
git clone https://github.com/g-otn/soat-tech-challenge.git
1213
cd soat-tech-challenge/
1314
```
15+
1416
2. Make sure:
17+
1518
- Port `30000` is available.
1619
- Kubernetes cluster is running.
1720

1821
3. Apply configuration files in the `kubernetes` folder:
19-
```
22+
23+
```bash
2024
kubectl apply -f kubernetes/
2125
```
26+
2227
This will create the `fiap-grupo-63` namespace and all the
2328
objects required to run the workload inside it.
2429

2530
4. If you're using minikube, you _need_ to forward the backend service using [`minikube service`](https://minikube.sigs.k8s.io/docs/commands/service/):
31+
2632
```
2733
minikube service soat-tech-challenge-backend-service -n fiap-grupo-63
2834
```
35+
2936
It'll automatically open a browser window with the proper URL.
3037

3138
5. If you're using Docker Desktop's Kubernetes you can access http://localhost:30000/ or http://localhost:30000/swagger-ui/index.html to access a live OpenAPI spec of the available endpoints.
@@ -85,10 +92,16 @@ Execute the steps in "Executing (for teachers)" at the beginning of this doc.
8592

8693
#### Generating configmap volume for SQL scripts
8794

88-
```
95+
```bash
8996
kubectl create configmap db-config --from-file=db/
9097
```
9198

99+
#### Running KubeLinter
100+
101+
```bash
102+
docker run --rm -v kubernetes/:/dir stackrox/kube-linter lint /di
103+
```
104+
92105
</details>
93106

94107
## Executing via docker-compose

0 commit comments

Comments
 (0)