MG-198 - Add post-deployment guide for k8s (#199)

* Updated cli usage command Signed-off-by: JeffMboya <[email protected]> * Updated cli usage Signed-off-by: JeffMboya <[email protected]> * Renamed mainflux to magistrala Signed-off-by: JeffMboya <[email protected]> * Start ignoring config.toml * Removed config.toml file Signed-off-by: JeffMboya <[email protected]> * Start ignoring config.toml * Renamed mainflux to magistrala Signed-off-by: JeffMboya <[email protected]> * Fixed URLs Signed-off-by: JeffMboya <[email protected]> * Fixed URLs Signed-off-by: JeffMboya <[email protected]> * Fixed Typos Signed-off-by: JeffMboya <[email protected]> * Reverted changes to events.md Signed-off-by: JeffMboya <[email protected]> * Reverted changes to events.md Signed-off-by: JeffMboya <[email protected]> * Rename MF_ to MG_ Signed-off-by: JeffMboya <[email protected]> * Add K8s post-deployment guide to README Signed-off-by: JeffMboya <[email protected]> * update docs Signed-off-by: JeffMboya <[email protected]> * Add postman collection Signed-off-by: JeffMboya <[email protected]> * Add postman collection Signed-off-by: JeffMboya <[email protected]> * revert CODEOWNERS Signed-off-by: JeffMboya <[email protected]> * revert CODEOWNERS Signed-off-by: JeffMboya <[email protected]> * Add link to CLI docs Signed-off-by: JeffMboya <[email protected]> --------- Signed-off-by: JeffMboya <[email protected]>
absmach · Sep 24, 2024 · a5dc6e9 · a5dc6e9
1 parent 9f110eb
commit a5dc6e9
Showing 1 changed file with 59 additions and 1 deletion.
diff --git a/docs/kubernetes.md b/docs/kubernetes.md
@@ -202,7 +202,65 @@ kubectl get services -n mg
 kubectl logs <pod-name> -n mg
 ```
 
----
+### Interacting with Magistrala Services After Deployment
+
+Once you have successfully deployed Magistrala, there are three primary ways you can interact with its services:
+
+- web-based User Interface (UI)
+- Magistrala CLI tool (learn more in the [CLI Documentation](https://docs.magistrala.abstractmachines.fr/cli/))
+- HTTP API Clients (e.g., cURL, Postman)
+
+The ingress-nginx-controller handles the routing for your deployed services using Kubernetes Ingress resources. To interact with your Magistrala UI or any other service exposed through this load balancer, the first step is to retrieve the Public IP address of this load balancer.
+
+You can usually find this IP address in your DigitalOcean dashboard under the "Networking" or "Load Balancers" section, or by using the following command in your terminal:
+
+    kubectl get svc -A | grep LoadBalancer
+
+This command searches all namespaces for services of type `LoadBalancer`. The output looks something like this:
+
+    ingress-nginx           ingress-nginx-controller                         LoadBalancer   10.245.192.202   138.68.126.8   80:30424/TCP,443:31752/TCP                        64d
+
+NOTE: The Public IP in this case is `138.68.126.8`.
+
+#### Using the Web-Based UI
+
+- Once you have the Public IP address, open your web browser.
+- In the address bar, enter the IP address followed by `/ui/login` as shown below:
+
+      http://138.68.126.8/ui/login
+
+#### Using Postman
+
+If you prefer working with APIs, you can also interact with Magistrala services using Postman by sending requests to the Public IP address of your load balancer. For example, to create a user:
+
+###### 1. Set Up the Postman Request
+
+- **Method:** `POST`
+- **URL:** `http://138.68.126.8/users`
+
+This URL points to the endpoint that handles user creation on your Magistrala deployment. Replace `138.68.126.8` with the actual IP address or domain of your deployment if it differs.
+
+###### 2. Set Up the Request Body
+
+Switch to the `Body` tab in Postman and select `raw` as the format. Choose `JSON` from the dropdown menu, and then enter the following JSON structure in the text area:
+
+```json
+{
+  "name": "user1",
+  "tags": ["tag1", "tag2"],
+  "credentials": {
+    "identity": "[email protected]",
+    "secret": "12345678"
+  },
+  "metadata": {
+    "domain": "domain1"
+  }
+}
+```
+
+`Send` the request. If successful, the server will respond with the details of the newly created user.
+
+For more examples, refer to this [Postman Collection](https://elements.getpostman.com/redirect?entityId=38532610-ef9a0562-b353-4d2c-8aca-a5fae35ad0ad&entityType=collection).
 
 ## Install Magistrala Charts (From Published Helm Repository)