Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
ramanan-ravi committed Oct 6, 2023
1 parent be17ca7 commit 0c8cbba
Show file tree
Hide file tree
Showing 8 changed files with 24 additions and 24 deletions.
16 changes: 8 additions & 8 deletions docs/docs/console/kubernetes.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,14 +49,14 @@ The following instructions explain how to install the ThreatMapper console on a
```bash
helm repo add deepfence https://deepfence-helm-charts.s3.amazonaws.com/threatmapper
# helm show values deepfence/deepfence-console --version 2.0.0 | less
# helm show values deepfence/deepfence-console --version 2.0.1 | less
helm install deepfence-console deepfence/deepfence-console \
--set global.imageTag=2.0.0 \
--set global.storageClass=gp3 \
--namespace deepfence-console \
--create-namespace \
--version 2.0.0
--version 2.0.1
```
... and wait for the pods to start up:
Expand All @@ -70,12 +70,12 @@ The following instructions explain how to install the ThreatMapper console on a
Deploy deepfence-router:
```bash
# helm show values deepfence/deepfence-router --version 2.0.0
# helm show values deepfence/deepfence-router --version 2.0.1
helm install deepfence-router deepfence/deepfence-router \
--namespace deepfence-console \
--create-namespace \
--version 2.0.0
--version 2.0.1
```
... and wait for the cloud platform to deploy an external load-balancer:
Expand All @@ -91,29 +91,29 @@ Now proceed to the [Initial Configuration](initial-configuration).
### Console Helm Chart
```bash
helm show values deepfence/deepfence-console --version 2.0.0 > deepfence_console_values.yaml
helm show values deepfence/deepfence-console --version 2.0.1 > deepfence_console_values.yaml
# Make the changes in this file and save
vim deepfence_console_values.yaml
helm install -f deepfence_console_values.yaml deepfence-console deepfence/deepfence-console \
--namespace deepfence-console \
--create-namespace \
--version 2.0.0
--version 2.0.1
```

### Router Helm Chart

```bash
helm show values deepfence/deepfence-router --version 2.0.0 > deepfence_router_values.yaml
helm show values deepfence/deepfence-router --version 2.0.1 > deepfence_router_values.yaml

# Make the changes in this file and save
vim deepfence_router_values.yaml

helm install -f deepfence_router_values.yaml deepfence-router deepfence/deepfence-router \
--namespace deepfence-console \
--create-namespace \
--version 2.0.0
--version 2.0.1
```

## Delete the ThreatMapper Management Console
Expand Down
4 changes: 2 additions & 2 deletions docs/docs/developers/deploy-agent.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ You can use these instructions for helm-based installations in standalone and ho
```bash
helm repo add deepfence https://deepfence-helm-charts.s3.amazonaws.com/threatmapper

helm show values deepfence/deepfence-agent --version 2.0.0 > deepfence_agent_values.yaml
helm show values deepfence/deepfence-agent --version 2.0.1 > deepfence_agent_values.yaml

# You will need to update the following values:
# image:name and image:clusterAgentImageName - change the account to point to your images
Expand All @@ -60,7 +60,7 @@ vim deepfence_agent_values.yaml
helm install -f deepfence_agent_values.yaml deepfence-agent deepfence/deepfence-agent \
--namespace deepfence \
--create-namespace \
--version 2.0.0
--version 2.0.1
```

Allow a few seconds for the containers to pull and deploy in your Kubernetes environment.
Expand Down
8 changes: 4 additions & 4 deletions docs/docs/developers/deploy-console.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,15 +47,15 @@ Refer to the [Kubernetes Installation Instructions](/docs/v2.0/console/kubernete
helm repo add deepfence https://deepfence-helm-charts.s3.amazonaws.com/threatmapper
# Create the values file
helm show values deepfence/deepfence-console --version 2.0.0 > deepfence_console_values.yaml
helm show values deepfence/deepfence-console --version 2.0.1 > deepfence_console_values.yaml
```

Edit the `deepfence_console_values.yaml` file, replacing the `image: repository:` value to point to your repository, and making any other changes as needed.

Install the management console:

```bash
helm install -f deepfence_console_values.yaml deepfence-console deepfence/deepfence-console --version 2.0.0
helm install -f deepfence_console_values.yaml deepfence-console deepfence/deepfence-console --version 2.0.1
```

Full instructions can be found in the [Console helm chart documentation](https://github.com/deepfence/ThreatMapper/tree/main/deployment-scripts/helm-charts/deepfence-console).
Expand All @@ -66,11 +66,11 @@ Refer to the [Kubernetes Installation Instructions](/docs/v2.0/console/kubernete

```bash
# Create the values file
helm show values deepfence/deepfence-router --version 2.0.0 > deepfence_router_values.yaml
helm show values deepfence/deepfence-router --version 2.0.1 > deepfence_router_values.yaml
```

Edit the `deepfence_router_values.yaml` file, replacing the `image: repository:` value to point to your repository, and making any other changes as needed.

```bash
helm install -f deepfence_router_values.yaml deepfence-router deepfence/deepfence-router --version 2.0.0
helm install -f deepfence_router_values.yaml deepfence-router deepfence/deepfence-router --version 2.0.1
```
10 changes: 5 additions & 5 deletions docs/docs/sensors/kubernetes.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,8 @@ kubectl delete -f https://deepfence-public.s3.amazonaws.com/kubernetes/deepfence
```bash
helm repo add deepfence https://deepfence-helm-charts.s3.amazonaws.com/threatmapper

# helm show readme deepfence/deepfence-agent --version 2.0.0 | less
# helm show values deepfence/deepfence-agent --version 2.0.0 | less
# helm show readme deepfence/deepfence-agent --version 2.0.1 | less
# helm show values deepfence/deepfence-agent --version 2.0.1 | less

helm install deepfence-agent deepfence/deepfence-agent \
--set managementConsoleUrl=x.x.x.x \
Expand All @@ -45,15 +45,15 @@ helm install deepfence-agent deepfence/deepfence-agent \
--set mountContainerRuntimeSocket.containerdSockPath="/run/containerd/containerd.sock" \
--namespace deepfence \
--create-namespace \
--version 2.0.0
--version 2.0.1
```

## Fine-tune the Helm deployment

```bash
helm repo add deepfence https://deepfence-helm-charts.s3.amazonaws.com/threatmapper

helm show values deepfence/deepfence-agent --version 2.0.0 > deepfence_agent_values.yaml
helm show values deepfence/deepfence-agent --version 2.0.1 > deepfence_agent_values.yaml

# You will need to update the following values:
# managementConsoleUrl and deepfenceKey - specify your URL/IP and API key value
Expand All @@ -65,7 +65,7 @@ vim deepfence_agent_values.yaml
helm install -f deepfence_agent_values.yaml deepfence-agent deepfence/deepfence-agent \
--namespace deepfence \
--create-namespace \
--version 2.0.0
--version 2.0.1
```

## Delete the ThreatMapper Sensor
Expand Down
4 changes: 2 additions & 2 deletions docs/docs/tips/sensor-agent-not-start.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ Running `kubectl describe pod -n deepfence deepfence-agent-8lxng` reveals:
```bash
helm delete deepfence-agent -n deepfence

helm show values deepfence/deepfence-agent --version 2.0.0 > deepfence_agent_values.yaml
helm show values deepfence/deepfence-agent --version 2.0.1 > deepfence_agent_values.yaml

# You will need to update the following values:
# containerdSock - set to "false"
Expand All @@ -35,5 +35,5 @@ vim deepfence_agent_values.yaml
helm install -f deepfence_agent_values.yaml deepfence-agent deepfence/deepfence-agent \
--namespace deepfence \
--create-namespace \
--version 2.0.0
--version 2.0.1
```
2 changes: 1 addition & 1 deletion golang_deepfence_sdk

0 comments on commit 0c8cbba

Please sign in to comment.