Skip to content

Commit

Permalink
update docs link (#25)
Browse files Browse the repository at this point in the history
  • Loading branch information
gnmahanth authored Sep 11, 2024
1 parent a8fbed5 commit 89ebb30
Showing 1 changed file with 4 additions and 40 deletions.
44 changes: 4 additions & 40 deletions helm-chart/README.md
Original file line number Diff line number Diff line change
@@ -1,44 +1,8 @@
# Using deepfence-cloud-scanner helm chart

### Single Account Cloud Scanner on EKS cluster using IAM roles for service accounts

1. **Prerequsite:** associate oidc provider with the EKS cluster where cloud scanner is installed ([aws docs](https://docs.aws.amazon.com/eks/latest/userguide/enable-iam-roles-for-service-accounts.html))
2. Create the EKS IRSA role using the terrafrom script [cloudformation/self-hosted/eks-iam-roles/single-account-eks-iam-role](cloudformation/self-hosted/eks-iam-roles/single-account-eks-iam-role)
3. Or create the EKS IRSA role using the cloudformation template [cloudformation/self-hosted/eks-iam-roles/single-account-eks-iam-role/deepfence-cloud-scanner-single-account-iam-role.template](cloudformation/self-hosted/eks-iam-roles/single-account-eks-iam-role/deepfence-cloud-scanner-single-account-iam-role.template)
4. Note *namespace*, *service account name* and *iam role arn* from the terrafrom or cloudformation output
5. Update the deepfence-cloud-scanner helm chart values with deepfence key and console url, add service account annotation and service account name
```yaml
serviceAccount:
# Specifies whether a service account should be created
create: true
# Automatically mount a ServiceAccount's API credentials?
automount: true
# Annotations to add to the service account
annotations:
"eks.amazonaws.com/role-arn": "arn:aws:iam::123456789:role/test-cloud-scanner"
# The name of the service account to use.
# If not set and create is true, a name is generated using the fullname template
name: "deepfence-cloud-scanner"
- Add deepfence cloud scanner helm repo
```
6. Install the helm chart in the same *namespace* from Step 3.
### Organization Account Cloud Scanner on EKS cluster using IAM roles for service accounts
1. **Prerequsite:** associate oidc provider with the EKS cluster where cloud scanner is installed ([aws docs](https://docs.aws.amazon.com/eks/latest/userguide/enable-iam-roles-for-service-accounts.html))
2. Create the EKS IRSA role using the cloudformation template [cloudformation/self-hosted/eks-iam-roles/organization-eks-iam-role/deepfence-cloud-scanner-organization-stackset-iam-role.template](cloudformation/self-hosted/eks-iam-roles/organization-eks-iam-role/deepfence-cloud-scanner-organization-stackset-iam-role.template)
3. Note *namespace*, *service account name* and *iam role arn* from the cloudformation output
4. Update the deepfence-cloud-scanner helm chart values with deepfence key and console url along with org details, add service account annotation and service account name
```yaml
serviceAccount:
# Specifies whether a service account should be created
create: true
# Automatically mount a ServiceAccount's API credentials?
automount: true
# Annotations to add to the service account
annotations:
"eks.amazonaws.com/role-arn": "arn:aws:iam::123456789:role/test-cloud-scanner"
# The name of the service account to use.
# If not set and create is true, a name is generated using the fullname template
name: "deepfence-cloud-scanner"
helm repo add cloud-scanner https://deepfence-helm-charts.s3.amazonaws.com/cloud-scanner
```
6. Install the helm chart in the same *namespace* from Step 3.
- Refer [here](https://docs.deepfence.io/threatmapper/docs/cloudscanner/aws) for docs on using cloud-scanner with ThreatMapper on AWS EKS cluster
- Refer [here](https://docs.deepfence.io/threatstryker/docs/cloudscanner/aws) for docs on using cloud-scanner with ThreatStryker on AWS EKS cluster

0 comments on commit 89ebb30

Please sign in to comment.