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.

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 deployment.md #62

Merged
merged 2 commits into from
Oct 10, 2024
Merged
Changes from all commits
Commits
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
4 changes: 2 additions & 2 deletions docs/how-to/deployment.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,8 @@ The `PUSH_AUDIT_LOGS_CONFIG` field must also be configured.

## Deploying audit-service 1.0.0

- **Systems where the audit-service has been deployed previously:** Fence 5.1.0 or more recent might NOT work with audit-service < 1.0.0. Update audit-service, then run `kubectl delete secret audit-g3auto` and `gen3 kube-setup-audit-service`. Then configure [PUSH_AUDIT_LOGS_CONFIG](https://github.com/uc-cdis/fence/blob/5.1.0/fence/config-default.yaml#L632-L636) in the Fence config (run `gen3 sqs info $(gen3 api safe-name audit-sqs)` to get the SQS URL) and run `kubectl delete secret fence-config` and `gen3 kube-setup-fence`.
- **Systems where the audit-service has never been deployed:** run `gen3 kube-setup-audit-service`. Then configure [ENABLE_AUDIT_LOGS](https://github.com/uc-cdis/fence/blob/5.1.0/fence/config-default.yaml#L624-L626) and [PUSH_AUDIT_LOGS_CONFIG](https://github.com/uc-cdis/fence/blob/5.1.0/fence/config-default.yaml#L632-L636) in the Fence config (run `gen3 sqs info $(gen3 api safe-name audit-sqs)` to get the SQS URL) and run `kubectl delete secret fence-config` and `gen3 kube-setup-fence`.
- **Systems where the audit-service has been deployed previously:** Fence 5.1.0 or more recent might NOT work with audit-service < 1.0.0. Update audit-service, then run `kubectl delete secret audit-g3auto` and `gen3 kube-setup-audit-service`. Then configure [PUSH_AUDIT_LOGS_CONFIG](https://github.com/uc-cdis/fence/blob/cd66a72/fence/config-default.yaml#L756-L760) in the Fence config (run `gen3 sqs info $(gen3 api safe-name audit-sqs)` to get the SQS URL) and run `kubectl delete secret fence-config` and `gen3 kube-setup-fence`.
- **Systems where the audit-service has never been deployed:** run `gen3 kube-setup-audit-service`. Then configure [ENABLE_AUDIT_LOGS](https://github.com/uc-cdis/fence/blob/cd66a72/fence/config-default.yaml#L748-L750) and [PUSH_AUDIT_LOGS_CONFIG](https://github.com/uc-cdis/fence/blob/cd66a72/fence/config-default.yaml#L756-L760) in the Fence config (run `gen3 sqs info $(gen3 api safe-name audit-sqs)` to get the SQS URL) and run `kubectl delete secret fence-config` and `gen3 kube-setup-fence`.

When deploying with Gen3 cloud-automation, there is no need to configure `PUSH_AUDIT_LOGS_CONFIG.aws_sqs_config.aws_cred` in the Fence configuration.

Expand Down
Loading