Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update version and add env placeholder with docs #6

Merged
merged 1 commit into from
Jul 9, 2024
Merged

update version and add env placeholder with docs #6

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 24 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,6 +90,27 @@ helm install $name .
kubectl create job --from=cronjob/$name $jobname
```

## Advanced Options (Oracle/Snowflake)

For scanning oracle or snowflake additional configuration needs to be added

For Oracle the service name needs to be provided (typically it should be set to `ORCL`)

```yaml
cronjob:
env:
- name: REPO_CRAWLER_REPO_ADVANCED
value: "{\"oracle\":{\"service-name\":\"ORCL\"}}"
```

For Snowflake we need to specify some additional information: Account, Role and Warehouse

```yaml
cronjob:
env:
- name: REPO_CRAWLER_REPO_ADVANCED
value: "{\"snowflake\":{\"account\":\"$account\",\"role\":\"$role\",\"warehouse\":\"$warehouse\"}}"

## Parameters

### Require parameters
Expand All @@ -114,7 +135,8 @@ Parameters related to connection to the Cyral control plane
| `cronjob.annotations` | | `{}` |
| `cronjob.podAnnotations` | Used to apply annotations to the job pod itself. Useful for Vault | `{}` |
| `cronjob.labels` | | `{}` |
| `cronjob.schedule` | | `0 0 * * 6` |
| `cronjob.env` | Additonal environment variables (used for advanced configuration) | `{}` |
| `cronjob.schedule` | Schedule for when to run the crawler | `0 0 * * 6` |
| `cronjob.restartPolicy` | | `Never` |
| `cronjob.resources` | Job Resource definition | |

Expand Down Expand Up @@ -142,7 +164,7 @@ Parameters related to connection to the Cyral control plane
| Name | Description | Value |
| ------------------- | --------------------------------------------------------------------------------------------------------- | ---------------------- |
| `imageRegistry` | Image registry to pull the crawler image from | `public.ecr.aws/cyral` |
| `tag` | Version/Tag of image to pull | `v0.11.1` |
| `tag` | Version/Tag of image to pull | `v0.12.4` |
| `imagePullPolicy` | Pull policy configuration | `IfNotPresent` |
| `imagePullSecrets` | Image pull secret configuration | `""` |
| `kubeVersion` | Force target Kubernetes version (using Helm capabilities if not set) | `""` |
Expand Down
7 changes: 5 additions & 2 deletions values.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,10 @@ cronjob:
## @param cronjob.labels
##
labels: {}
## @param cronjob.schedule
## @param cronjob.env Additonal environment variables (used for advanced configuration)
##
env: {}
## @param cronjob.schedule Schedule for when to run the crawler
##
schedule: "0 0 * * 6"
## @param cronjob.restartPolicy
Expand Down Expand Up @@ -110,7 +113,7 @@ cronjob:
imageRegistry: public.ecr.aws/cyral
## @param tag Version/Tag of image to pull
##
tag: v0.11.1
tag: v0.12.4
## @param imagePullPolicy Pull policy configuration
##
imagePullPolicy: IfNotPresent
Expand Down
Loading