Skip to content

Latest commit

 

History

History
80 lines (62 loc) · 2.32 KB

configuration_file.md

File metadata and controls

80 lines (62 loc) · 2.32 KB
Raw

Configuration File

Configuration file must contains at least the DEFAULT section with the OCI config and OCI_TOOLS section with the script configuration. OCI configuration file are also supported with the command line parameter --profile <profile_name>

Below the list of supported value in the OCI_TOOLS section

region_filter

Comma separated region to work on. Currently must not be empty.

region_filter=eu-frankfurt-1,uk-london-1

operation

This parameter can be overridden by command line argument available operation:

  • list: scan the tenancy and list all the resources (Default)
  • cleanup: delete all but toplevel compartments
  • dryrun: emulate cleanup without affect any resource
  • destroy: delete all (NOT IMPLEMENTED)
operation=cleanup

preserve_compartments

Comma separated list of compartments to keep safe. The cleanup process ignores all the listed compartments and the resources that belong to them

preserve_compartments=comp_1,comp_2

preserve_tags

comma separated list of tag to keep safe.
The cleanup process ignores all the resources tagged with at least one of the listed tags

  • freeform tags must be inserted it the following format:
    • key=value
    • key
  • defined tags must be inserted in the following format:
    • namespace:key=value
preserve_tags=training.foundation=true,safe=true,not_delete

compartment_flter

Comma separated compartment OCID to limit the cleanup to. The cleanup process will consider only the listed compartments
If empty all the compartment are terminated

compartment_flter=my_compartment

preserve_top_level_compartment

If true the cleanup script ignores the top level compartments
In case compartment_filter is used then the compartments specified is considered as top level compartments
Default value: false

preserve_top_level_compartment=true

preserve_compartments

Preserve the compartment structure. The cleanup script deletes all the resources but the compartments
Default value: false

preserve_compartments=true

skip_scan_preserved_resources

if True don't inspect preserved resources (via preserve_compartments or preserve_tags) Default value: true

skip_scan_preserved_resources=false