Skip to content

Commit edc3cdb

Browse files
committed
update docs + designs
1 parent c3f872f commit edc3cdb

6 files changed

Lines changed: 5005 additions & 6 deletions

File tree

Makefile

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
run build start pause stop status logs rm-volumes prune clean reset \
44
migrate-up migrate-down migrate-status migrate-create \
55
generate seed \
6-
kube-setup kube-deploy kube-delete kube-reset \
6+
kube-start kube-deploy kube-delete kube-reset \
77
kube-status kube-nodes kube-pods kube-svc kube-deployments kube-logs \
88
kube-forward kube-tunnel
99

@@ -93,8 +93,8 @@ seed:
9393

9494
### k8s commands for Kubernetes deployment
9595

96-
kube-setup:
97-
./tools/scripts/k8s.sh setup
96+
kube-start:
97+
./tools/scripts/k8s.sh start
9898

9999
kube-deploy:
100100
./tools/scripts/k8s.sh deploy $(pod)
@@ -123,8 +123,14 @@ kube-deployments:
123123
kube-logs:
124124
./tools/scripts/k8s.sh logs $(pod)
125125

126+
kube-dashboard:
127+
minikube dashboard -p fafnir-cluster
128+
129+
kube-ssh:
130+
minikube ssh -p fafnir-cluster
131+
126132
kube-forward:
127133
./tools/scripts/k8s.sh forward $(pod)
128134

129135
kube-tunnel:
130-
minikube tunnel
136+
minikube tunnel -p fafnir-cluster

docs/architecture.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
### Architecture Designs
44
- [Initial Design #1](designs/images/dev_design_1.png)
55
- [Revised Design of #1](designs/images/revised_dev_design_1.png)
6+
- [Kubernetes Node & Network Design](designs/images/k8s_node_network_design_1.png)
67

78
### Key Architectural Principles
89
- **Microservices**: Each service has its own database and is independently deployable
@@ -91,3 +92,4 @@ Below is the ideal data flow for the application. It will be updated when NATS i
9192
- [19 Microservices Patterns for System Design Interviews](https://dev.to/somadevtoo/19-microservices-patterns-for-system-design-interviews-3o39) by [Soma](https://dev.to/somadevtoo)
9293
- [A Crash Course on Microservices Design Patterns](https://blog.bytebytego.com/p/a-crash-course-on-microservices-design) by [ByteByteGo](https://blog.bytebytego.com/about)
9394
- [NATS Documentation](https://docs.nats.io/) by [NATS](https://nats.io/about/)
95+
- [Kubernetes Documentation](https://kubernetes.io/docs/concepts/architecture/) by [Kubernetes](https://kubernetes.io/)

0 commit comments

Comments
 (0)