Skip to content

Commit

Permalink
Update Docs for ClamAV in Container (#16058) (#16680)
Browse files Browse the repository at this point in the history
* use clamav container for local development and review instances

* rubocop formatting & CODEOWNERS

* fix Dockerfile

* update CODEOWNERS and docker-compose version for review instances

* change docker-compose verions for review

* fix review ports

* update github workflows to match k8s

* update github workflows

* update code_checks for docker compose for tests

* add bundle exec to setup db step in audit service tags

* reset db in docker compose review & update audit service tag docker services

* remove clamd and freshclam from procfile

* add sidekiq enterprise license to test env var

* set sidekiq license to docker build args

* update makefile to work with new docker services

* update hybrid docs

* add clamav host & port to settings

* add restart services to docker-compose review

* update hybrid and native docs for clamav

* remove clamav setup for ubuntu

* add clamav configration info for docker setup

* Added virus scan to uploads spec (#16393)

* Added virus scan to uploads spec

* Fixing Virus scan spec

* resolve merge conflict

* change directory from /app to /srv/vets-api/src

* use previous master version for RI + clam containers

* add USER_ID to RI docker-compose

* set working directory back to app

* minor clean up with new line EOF & remove k8s deploy related code

* update makefile up command with foreman

* fix docker-compose clamav new line

* more cleanup and rubocop formatting

* remove redis ports from docker-compose test

* update redis port

* revert docker-compose test to original master

* update api service name to web

* rubocop formatting

* add Procfile to CODEOWNERS

* update CODEOWNERS

* add secret and pki volumes back to RI

* add some settings in review docker-compose

* fix merge conflict mistake in Dockerfile

* fix merge conflict

* add rvm install ruby version troubleshooting tip

* update dockerfile ruby version

* resolve merge conflict

* rephrase heading

* update clamav daemon socket docs and comment socket env var

* correct phrasing

* update from GH comments

---------

Co-authored-by: stevenjcumming <[email protected]>
  • Loading branch information
RachalCassity and stevenjcumming authored May 8, 2024
1 parent 6af1011 commit dedb5af
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 0 deletions.
1 change: 1 addition & 0 deletions docs/setup/hybrid.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ redis:

*Note: If you have local instances of Postgres or Redis that were only for use by vets-api, you can stop them to save system resources.*


## Running Deps

Prior to EKS, ClamAV (the virus scanner) was deployed in the same process as Vets API. With EKS, ClamAV has been extracted out into it’s own service. Locally you can see the docker-compose.yml config for clamav.
Expand Down
2 changes: 2 additions & 0 deletions docs/setup/native.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ We suggest using a Ruby version manager such as `rbenv`, `asdf`, `rvm`, or `chru

If the repo's Ruby version is updated later, you will need to install the newer ruby (i.e., `rvm install <version_number>`) which is located in `.ruby-version`


### RVM Troubleshooting

If you see an error like `Error running '__rvm_make -j10'` while installing a ruby version, this usually occurs because of a mismatch with the openssl package.
Expand Down Expand Up @@ -88,6 +89,7 @@ track_activity_query_size = 2048
**Make sure to migrate your database to enable the [pg_stat_statements extension](https://github.com/department-of-veterans-affairs/vets-api/blob/master/db/migrate/20210507122840_add_stats_extension.rb)**
## Settings and configuration
We use the `config` gem to manage settings in the application. Local settings for each developer should be managed in your own local `config/settings.local.yml` file, which by default can override the standard configuration _and_ is excluded from source control so the settings can persist.
Expand Down
1 change: 1 addition & 0 deletions docs/setup/running_natively.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ After that, follow the native instructions and run `foreman start -m all=1`

#### Option 2: [See hybrid setup](https://github.com/department-of-veterans-affairs/vets-api/blob/k8s/docs/setup/hybrid.md)


### Running tests

- `bundle exec rake spec` - Run the entire test suite ( for `rspec spec`). Test coverage statistics are in `coverage/index.html`.
Expand Down

0 comments on commit dedb5af

Please sign in to comment.