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.

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

[CLI] Option for starting Sequence with a path to start-up JSON file #969

Open
a-tylenda opened this issue Oct 26, 2023 · 0 comments
Open
Labels
group:interface Issues regarding API or CLI read Read by sequences

Comments

@a-tylenda
Copy link
Contributor

This is how options for starting Sequence look like:

Current profile: default
Usage: si sequence start [options] <id>

Start the Sequence with or without given arguments

Arguments:
  id                                 Sequence id to start or '-' for the last uploaded

Options:
  -f, --config-file <path-to-file>   Path to configuration file in JSON format to be passed to the Instance context
  -s, --config-string <json-string>  Configuration in JSON format to be passed to the Instance context
  --inst-id <string>                 Start Sequence with a custom Instance Id. Should consist of 36 characters
  --output-topic <string>            Topic to which the output stream should be routed
  --input-topic <string>             Topic to which the input stream should be routed
  --args <json-string>               Arguments to be passed to the first function in the Sequence
  --limits <json-string>             Instance limits
  -h, --help                         Display help for command

Global Options:
  -v, --version                      Display current SI version
  --config <profile-name>            Use configuration from profile
  --config-path <path>               Use configuration from file
  --progress                         Global flag, used to display progress (currently used only in 'si seq send/deploy' command

You can start a sequence with multiple options using flags like:

  • --inst-id <string>
  • --args <json-string>
  • --output-topic <string>
  • etc.

What is missing is a flag like --startup-config <path> that will include all the options in one JSON file, so that they can be passed to the Instance at once.
Config would be based on type StartSequencePayload:

export type StartSequencePayload = {
    appConfig: AppConfig,
    args?: any[],
    outputTopic?: string,
    inputTopic?: string,
    limits?: InstanceLimits,
    instanceId?: string
}
@scramjet-bot scramjet-bot added the read Read by sequences label Oct 26, 2023
@alicja-gruzdz alicja-gruzdz added the group:interface Issues regarding API or CLI label Oct 26, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
group:interface Issues regarding API or CLI read Read by sequences
Projects
None yet
Development

No branches or pull requests

3 participants