diff --git a/docs/exports.md b/docs/exports.md index cbf0e3b02..a35d7632e 100644 --- a/docs/exports.md +++ b/docs/exports.md @@ -142,6 +142,7 @@ Full exports can only be run via a **rake task**. If the collection size is very large, full exports may fail due to memory issues. In such cases: + - Delete the incomplete export files from the S3 bucket. - It is better to batch exports into chunks of ~60,000 records and run several partial exports over multiple days. The `values_updated_at` field can help with this. - Rerun the task with more memory allocated, see 'Running Rake Tasks'. diff --git a/docs/rake.md b/docs/rake.md index 538b49f78..0fc28eb5c 100644 --- a/docs/rake.md +++ b/docs/rake.md @@ -3,42 +3,56 @@ nav_order: 11 --- # Running Rake Tasks + On CORE, we sometimes need to run a Rake task manually on one of our deployed environments. ## Rake Tasks + Rake tasks are defined in the `lib/tasks` directory of a Rails application. ## Running Rake Tasks locally + This can be done from the command line: + ```bash bundle exec rake ``` ## Running Rake Tasks on CORE infrastructure + ### Get access to an AWS CLI + TODO docs on this ### Set up environment variables + Set the env as appropriate: + ```bash export env=prod ``` + Other options are `staging` or `review-XXXX`, where `XXXX` is the review app number. Set up the Rake Task as appropriate: + ```bash export rake_task= ``` + Where `` is the name of the Rake task you want to run, local equivalent would be `bundle exec rake `. Set up the CPU and memory requirements for the task: + ```bash export cpu_value=1024 export memory_value=2048 ``` + See [the AWS documentation](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definition_parameters.html#task_size) for valid CPU and memory pairs. Set the other environment variables: + ```bash export cluster=core-$env-app export service=core-$env-app @@ -48,11 +62,13 @@ export overrides="{ \"containerOverrides\" : [{ \"name\" : \"app\", \"command\" ``` ### Start the Rake Task + ```bash aws ecs run-task --cluster $cluster --task-definition $ad_hoc_task_definition --network-configuration "$network" --overrides "$overrides" --launch-type FARGATE --query tasks[0].taskArn ``` - + The task ARN will be printed to the console. ### View the Task progress + This can be viewed in the AWS console by navigating to the ECS cluster specified in the environment variables, listing all tasks in the cluster, and selecting the task with the ARN printed in the previous step.