State Settings
You can configure where UFO stores state. UFO only stores state specifically if you’re using the Base Docker Image feature.
Example
By default, UFO will create a ufo CloudFormation stack and create a managed s3 bucket to store the state. You can use your own s3 bucket, though, by configuring this setting:
.ufo/config.rb
Ufo.configure do |config|
# When state.bucket is not set ufo creates a managed s3 bucket
config.state.bucket = "my-existing-bucket" # Set to use existing bucket.
# config.state.managed = true # false will disable creation of managed bucket entirely
# config.state.storage = "s3" # s3 or file
end
It’s probably easier to leave the defaults, so you do not have to remember to create an s3 bucket.
Reference
The table below covers each setting. Each option is configured in .ufo/config.rb with config.OPTION. The config. portion is not shown for conciseness. IE: logger.level vs config.logger.level.
| Name | Default | Description |
|---|---|---|
| state.bucket | Can be set to use an existing bucket. When not set ufo creates a managed s3 bucket. Using this setting means the managed option is ignored. |
nil |
| state.managed | Setting to false disables creation of managed bucket entirely. |
true |
| state.reminder | When set to false, it disables reminder message about committing the state file. When using storage provider file, a reminder a message to the user is shown to commit the changes to the local state file. |
true |
| state.storage | State storage provider. IE: s3 or file | s3 |