formating and ssl docs

README.md

@@ -15,7 +15,7 @@ export BUCKET_REGION=us-east-1
 
 ## A note on the database
 
-Running a MySQL database in your k8s cluster is not recommended.  This chart does not provide any way to backup the data or ensure the database can scale.  You'll need to manually increase the resources requested for the database and the size of the volume as load increases.  If possible you should use an external database service and set the following variables:
+Running a MySQL database in your k8s cluster is not recommended. This chart does not provide any way to backup the data or ensure the database can scale. You'll need to manually increase the resources requested for the database and the size of the volume as load increases. If possible you should use an external database service and set the following variables:
 
 ```shell
 --set mysql.managed=false --set mysql.host=db.host --set mysql.user=wandb --set mysql.password=XXX --set mysql.database=wandb
@@ -46,6 +46,40 @@ cd helm-charts
 helm upgrade --namespace=wandb --create-namespace --install wandb ./charts/wandb --set license=$LICENSE --set bucket=$BUCKET --set bucketRegion=$BUCKET_REGION
 ```
 
+# Mounting SSL Certificates to the Deployment
+
+To mount SSL certificates to your wandb deployment, follow these steps:
+
+1. Create a Kubernetes secret containing the SSL certificate and private key:
+
+```bash
+kubectl create secret tls wandb-tls --cert=path/to/tls.crt --key=path/to/tls.key -n wandb
+```
+
+Replace `path/to/tls.crt` and `path/to/tls.key` with the paths to your SSL certificate and private key files, respectively.
+
+2. Update your `values.yaml` file to configure the ingress to use the created secret for TLS:
+
+```yaml
+ingress:
+    enabled: true
+    ...
+    tls:
+    - secretName: wandb-tls
+    hosts:
+        - your-domain.com
+```
+
+Replace `your-domain.com` with your desired domain name.
+
+3. Apply the changes by upgrading the Helm release:
+
+```bash
+helm upgrade --namespace=wandb wandb ./charts/wandb --set license=$LICENSE --set bucket=$BUCKET --set bucketRegion=$BUCKET_REGION
+```
+
+Now, your wandb deployment will use the mounted SSL certificate for securing communication over HTTPS.
+
 # Upgrade Guide
 
-For information on upgrading the Helm module and wandb server version, please refer to the [upgrade guide](./upgrade.md).
+For information on upgrading the Helm module and wandb server version, please refer to the [upgrade guide](./upgrade.md).

upgrade.md

@@ -7,50 +7,53 @@ This guide describes how to upgrade the Helm module and wandb server version in
 1. Update the Helm repo to fetch the latest charts:
 
 ```bash
-   helm repo update
+helm repo update
 ```
+
 2. Check the available versions of the wandb Helm chart:
 
 ```bash
-   helm search repo wandb --versions
+helm search repo wandb --versions
 ```
 
 3. Choose the desired version and upgrade the Helm release:
 
-``` bash
-   helm upgrade --namespace=wandb wandb wandb/wandb --version <desired_version> --set license=$LICENSE --set bucket=$BUCKET --set bucketRegion=$BUCKET_REGION
+```bash
+helm upgrade --namespace=wandb wandb wandb/wandb --version <desired_version> --set license=$LICENSE --set bucket=$BUCKET --set bucketRegion=$BUCKET_REGION
 ```
-   Replace <desired_version> with the version you want to upgrade to.
+
+Replace <desired_version> with the version you want to upgrade to.
 
 ## Upgrading the wandb Server Version
 
 1. Update the `values.yaml` file by setting the desired wandb server image tag:
+
 ```yaml
-   image:
-     repository: wandb/local
-     pullPolicy: always
-     tag: "<desired_wandb_version>"
+image:
+  repository: wandb/local
+  pullPolicy: always
+  tag: "<desired_wandb_version>"
 ```
 
-   Replace <desired_wandb_version> with the version you want to upgrade to.
+Replace <desired_wandb_version> with the version you want to upgrade to.
 
 2. Apply the changes by upgrading the Helm release:
 
 ```bash
-   helm upgrade --namespace=wandb wandb ./charts/wandb --set license=$LICENSE --set bucket=$BUCKET --set bucketRegion=$BUCKET_REGION
+helm upgrade --namespace=wandb wandb ./charts/wandb --set license=$LICENSE --set bucket=$BUCKET --set bucketRegion=$BUCKET_REGION
 ```
 
 3. Monitor the deployment progress to ensure the new version is running:
 
 ```bash
-   kubectl -n wandb get pods
+kubectl -n wandb get pods
 ```
 
 4. Verify the upgraded wandb server version by checking the logs:
 
 ```bash
-   kubectl -n wandb get po
-   kubectl -n wandb logs <wandb_pod_name>
+kubectl -n wandb get po
+kubectl -n wandb logs <wandb_pod_name>
 ```
 
-   Replace <wandb_pod_name> with the name of the wandb pod in your deployment.
+Replace <wandb_pod_name> with the name of the wandb pod in your deployment.