Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(cosmovisor): add ability to run custom preupgrade script #16550

Merged
merged 9 commits into from
Jun 27, 2023
Merged

feat(cosmovisor): add ability to run custom preupgrade script #16550

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
976ff2e
Add custom preupgrade executable call to cosmovisor
chillyvee Jun 14, 2023
362c8dc
Document COSMOVISOR_CUSTOM_PREUPGRADE
chillyvee Jun 14, 2023
572ae36
Update CHANGELOG
chillyvee Jun 14, 2023
6ba414c
Move changelog, clarify pre-upgrade custom script
chillyvee Jun 14, 2023
7635f40
Use helper UpgradeInfoFilePath
chillyvee Jun 14, 2023
88ef8be
preupgrade tests
chillyvee Jun 24, 2023
3a7d364
check plan using ValidateBasic
chillyvee Jun 25, 2023
401e6fe
test output to buffer, check missing.sh return type and value
chillyvee Jun 27, 2023
eb9fddf
clarify comment setting execute bits
chillyvee Jun 27, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions tools/cosmovisor/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@ Ref: https://keepachangelog.com/en/1.0.0/
## Features

* [#16573](https://github.com/cosmos/cosmos-sdk/pull/16573) Extend `cosmovisor` configuration with new log format options
* [#16550](https://github.com/cosmos/cosmos-sdk/pull/16550) Add COSMOVISOR_CUSTOM_PREUPGRADE to cosmovisor to execute custom pre-upgrade scripts (separate from daemon pre-upgrade).
* [#15361](https://github.com/cosmos/cosmos-sdk/pull/15361) Add `cosmovisor config` command to display the configuration used by cosmovisor.
* [#12457](https://github.com/cosmos/cosmos-sdk/issues/12457) Add `cosmovisor pre-upgrade` command to manually add an upgrade to cosmovisor.

Expand Down
10 changes: 6 additions & 4 deletions tools/cosmovisor/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,6 +97,7 @@ Use of `cosmovisor` without one of the action arguments is deprecated. For backw
* `COSMOVISOR_DISABLE_LOGS` (defaults to `false`). If set to true, this will disable Cosmovisor logs (but not the underlying process) completely. This may be useful, for example, when a Cosmovisor subcommand you are executing returns a valid JSON you are then parsing, as logs added by Cosmovisor make this output not a valid JSON.
* `COSMOVISOR_COLOR_LOGS` (defaults to `true`). If set to true, this will colorise Cosmovisor logs (but not the underlying process).
* `COSMOVISOR_TIMEFORMAT_LOGS` (defaults to `kitchen`). If set to a value (`layout|ansic|unixdate|rubydate|rfc822|rfc822z|rfc850|rfc1123|rfc1123z|rfc3339|rfc3339nano|kitchen`), this will add timestamp prefix to Cosmovisor logs (but not the underlying process).
* `COSMOVISOR_CUSTOM_PREUPGRADE` (defaults to ``). If set, this will run $DAEMON_HOME/cosmovisor/$COSMOVISOR_CUSTOM_PREUPGRADE prior to upgrade with the arguments [ upgrade.Name, upgrade.Height ]. Executes a custom script (separate and prior to the chain daemon pre-upgrade command)

### Folder Layout

Expand All @@ -109,10 +110,11 @@ Use of `cosmovisor` without one of the action arguments is deprecated. For backw
│   └── bin
│   └── $DAEMON_NAME
└── upgrades
└── <name>
├── bin
│   └── $DAEMON_NAME
└── upgrade-info.json
│ └── <name>
│ ├── bin
│ │   └── $DAEMON_NAME
│ └── upgrade-info.json
└── preupgrade.sh (optional)
```

The `cosmovisor/` directory incudes a subdirectory for each version of the application (i.e. `genesis` or `upgrades/<name>`). Within each subdirectory is the application binary (i.e. `bin/$DAEMON_NAME`) and any additional auxiliary files associated with each binary. `current` is a symbolic link to the currently active directory (i.e. `genesis` or `upgrades/<name>`). The `name` variable in `upgrades/<name>` is the lowercased URI-encoded name of the upgrade as specified in the upgrade module plan. Note that the upgrade name path are normalized to be lowercased: for instance, `MyUpgrade` is normalized to `myupgrade`, and its path is `upgrades/myupgrade`.
Expand Down
11 changes: 8 additions & 3 deletions tools/cosmovisor/args.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@ const (
EnvDisableLogs = "COSMOVISOR_DISABLE_LOGS"
EnvColorLogs = "COSMOVISOR_COLOR_LOGS"
EnvTimeFormatLogs = "COSMOVISOR_TIMEFORMAT_LOGS"
EnvCustomPreupgrade = "COSMOVISOR_CUSTOM_PREUPGRADE"
)

const (
Expand Down Expand Up @@ -61,6 +62,8 @@ type Config struct {
DisableLogs bool
ColorLogs bool
TimeFormatLogs string
CustomPreupgrade string

// currently running upgrade
currentUpgrade upgradetypes.Plan
}
Expand Down Expand Up @@ -148,9 +151,10 @@ func (cfg *Config) CurrentBin() (string, error) {
func GetConfigFromEnv() (*Config, error) {
var errs []error
cfg := &Config{
Home: os.Getenv(EnvHome),
Name: os.Getenv(EnvName),
DataBackupPath: os.Getenv(EnvDataBackupPath),
Home: os.Getenv(EnvHome),
Name: os.Getenv(EnvName),
DataBackupPath: os.Getenv(EnvDataBackupPath),
CustomPreupgrade: os.Getenv(EnvCustomPreupgrade),
}

if cfg.DataBackupPath == "" {
Expand Down Expand Up @@ -431,6 +435,7 @@ func (cfg Config) DetailString() string {
{EnvDisableLogs, fmt.Sprintf("%t", cfg.DisableLogs)},
{EnvColorLogs, fmt.Sprintf("%t", cfg.ColorLogs)},
{EnvTimeFormatLogs, cfg.TimeFormatLogs},
{EnvCustomPreupgrade, cfg.CustomPreupgrade},
}

derivedEntries := []struct{ name, value string }{
Expand Down
Loading