README.md

quota-limits-generator

A tool to generate YAML files for OCP quotas and limits based of pre-defined inputs.

---

From Source

Build

mvn clean install

Run

java -jar target/quota-limits-generator-parent-*-jar-with-dependencies.jar \
    --instance-type-csv file:$(PWD)/data/instancetypes.csv --quality-of-service besteffort --instance-type small \
    --node-worker-count 2 --is-team-namespace true --request-ratio 3 \
    --output ${PWD}/output

From Release

Run

    curl -L http://central.maven.org/maven2/com/garethahealy/quota-limits-generator/quota-limits-generator-parent/1.0.1/quota-limits-generator-parent-1.0.1-jar-with-dependencies.jar -o quota-limits-generator.jar

java -jar quota-limits-generator.jar \
    --instance-type-csv file:$(PWD)/data/instancetypes.csv --quality-of-service besteffort --instance-type small \
    --node-worker-count 2 --is-team-namespace true --request-ratio 3 \
    --output ${PWD}/output

Options explained

Path to instance type CSV

--instance-type-csv file:$(PWD)/data/instancetypes.csv 

Quality of service required for the project

• besteffort = no requests or limits required to be set.
• burstable = forces the developer to use requests and limits

--quality-of-service besteffort

How much CPU and memory to use

--instance-type small

Number of nodes in the cluster

--node-worker-count 2 

Whether the limits/quotas apply to a group of OCP projects (true) or just a single project (false)

--is-team-namespace true

How much the limit can be above the request, i.e.:

• request = 10mb
• limit = 30mb MAX

In the above example, if you requested a limit of 31mb, the pod would fail.

--request-ratio 3

Output to where the YAML files will be created

--output ${PWD}/output