[CASSANDRA-16871] Add resource flags to CircleCi config generation script

• Type: Task
• Status: Resolved
• Priority: Low
• Resolution: Fixed
• Fix Version/s: 3.0.26, 3.11.12, 4.0.2, 4.1-alpha1, 4.1
• Component/s: CI
• Change Category: Quality Assurance
• Complexity: Low Hanging Fruit
• Platform: All

Source Control Link

https://github.com/apache/cassandra/commit/e4b37c3271c0e91407816d3c5370ebc8b95a615a

Test and Documentation Plan

Testing should be done manually by running the modified script. The patch includes changes in the documentation for CircleCI.

• Assignee: Andres de la Peña
• Reporter: Andres de la Peña

Authors

Andres de la Peña

Reviewers

Ekaterina Dimitrova

• Created: 20/Aug/21 10:33
• Updated: 27/May/22 19:25
• Resolved: 01/Sep/21 14:39

Description

Currently we have three versions of the CircleCI config file using different resources. Changing the resources configuration is as easy as copying the desired template file, for example:

cp .circleci/config.yml.MIDRES .circleci/config.yml

If we want to make changes to the file, for example to set a specific dtest repo or running the test multiplexer, we can run the provided generation script, copy the template file and probably exclude the additional changes:

# edit config-2_1.yml
.circleci/generate.sh
cp .circleci/config.yml.MIDRES .circleci/config.yml
# undo the changes in config.yml.LOWRES, config.yml.MIDRES and config.yml.HIGHRES

A very common alternative to this is just editing the environment variables in the automatically generated config.yml file, which are repeated some 19 times across the file:

cp .circleci/config.yml.MIDRES .circleci/config.yml
# edit config.yml, where env vars are repeated

I think we could do this slightly easier by adding a set of flags to the generation script to apply the resources patch directly to config.yml, without changing the templates:

# edit config-2_1.yml
.circleci/generate.sh -m

This has the advantage of not requiring manually editing the automatically generated file and also providing some validation.

Issue Links

• relates to: CASSANDRA-16989 Add environment variables to CircleCI config generation script
• links to: PR 3.0