updated docs

CloudDefenseAI · Feb 7, 2024 · 35c6f02 · 35c6f02
1 parent 8b06c08
commit 35c6f02
Show file tree

Hide file tree

Showing 2 changed files with 59 additions and 55 deletions.
diff --git a/README.md b/README.md
@@ -180,58 +180,3 @@ In order to sign in with different identity providers (for ex. github), create I
     ```
 
 - restart authservice pod
-
-## How to change location of logs
-
-- update value.yaml
-
-    ```yaml
-    api:
-      logs: 
-        region: <REGION>
-        bucket: <BUCKET>
-    ```
-
-### in case of private bucket
-
-- Edit the scan-server-secrets.yaml file
-
-  ```yaml
-    AWS_SCAN_S3_ACCESS_KEY: <AWS_SCAN_S3_ACCESS_KEY>
-    AWS_SCAN_S3_SECRET_KEY: <AWS_SCAN_S3_SECRET_KEY>
-  ```
-
-  ```sh
-  kubectl apply -f scan-server-secrets.yaml
-  ```
-
-- or update secrets on cluster
-
-    - encode values as base64 strings
-
-    ```sh
-    AWS_SCAN_S3_ACCESS_KEY=<AWS_ACCESS_KEY>
-    BASE64_AWS_SCAN_S3_ACCESS_KEY=$(echo $AWS_SCAN_S3_ACCESS_KEY | base64)
-    ```
-
-    ```sh
-    AWS_SCAN_S3_SECRET_KEY=<AWS_SECRET_KEY>
-    BASE64_AWS_SCAN_S3_ACCESS_KEY=$(echo $AWS_SCAN_S3_SECRET_KEY | base64)
-    ```
-
-    - edit scan-server-secrets
-
-    ```sh
-    kubectl edit secret scan-server-secrets
-    ```
-
-    ```yaml
-      AWS_SCAN_S3_ACCESS_KEY: <BASE64_AWS_SCAN_S3_ACCESS_KEY>
-      AWS_SCAN_S3_SECRET_KEY: <BASE64_AWS_SCAN_S3_SECRET_KEY>
-    ```
-
-- save and restart api pod
-
-  ```sh
-  kubectl delete pod api-<some-string>
-  ```
diff --git a/docs/aws/How to change location of logs.md b/docs/aws/How to change location of logs.md
@@ -0,0 +1,59 @@
+# How to change location of logs
+
+- update values.yaml
+
+    ```yaml
+    api:
+      logs: 
+        region: <REGION>
+        bucket: <BUCKET>
+    ```
+- upgrade helm chart
+
+    ```sh
+    helm upgrade cdefense charts/cdefense -f values.yaml --debug    
+    ```
+
+## In case of private bucket
+
+- Edit the scan-server-secrets.yaml file
+
+  ```yaml
+    AWS_SCAN_S3_ACCESS_KEY: <AWS_SCAN_S3_ACCESS_KEY>
+    AWS_SCAN_S3_SECRET_KEY: <AWS_SCAN_S3_SECRET_KEY>
+  ```
+
+  ```sh
+  kubectl apply -f scan-server-secrets.yaml
+  ```
+
+- or update secrets on cluster
+
+    - encode values as base64 strings
+
+    ```sh
+    AWS_SCAN_S3_ACCESS_KEY=<AWS_ACCESS_KEY>
+    BASE64_AWS_SCAN_S3_ACCESS_KEY=$(echo $AWS_SCAN_S3_ACCESS_KEY | base64)
+    ```
+
+    ```sh
+    AWS_SCAN_S3_SECRET_KEY=<AWS_SECRET_KEY>
+    BASE64_AWS_SCAN_S3_ACCESS_KEY=$(echo $AWS_SCAN_S3_SECRET_KEY | base64)
+    ```
+
+    - edit scan-server-secrets
+
+    ```sh
+    kubectl edit secret scan-server-secrets
+    ```
+
+    ```yaml
+      AWS_SCAN_S3_ACCESS_KEY: <BASE64_AWS_SCAN_S3_ACCESS_KEY>
+      AWS_SCAN_S3_SECRET_KEY: <BASE64_AWS_SCAN_S3_SECRET_KEY>
+    ```
+
+- save and restart api pod
+
+  ```sh
+  kubectl delete pod api-<some-string>
+  ```