README
¶
ecschedule
ecschedule is a tool to manage ECS Scheduled Tasks.
Synopsis
% ecschedule [dump|apply|run|diff] -conf ecschedule.yaml -rule $ruleName
Description
The ecschedule manages ECS Schedule tasks using a YAML configuration file like following.
region: us-east-1
cluster: clusterName
- name: taskName1
description: task 1
scheduledExpression: cron(30 15 ? * * *)
taskDefinition: taskDefName
containerOverrides:
- name: containerName
command: [subcommand1, arg]
environment:
HOGE: foo
FUGA: {{ must_env `APP_FUGA` }}
- name: taskName2
description: task2
scheduledExpression: cron(30 16 ? * * *)
taskDefinition: taskDefName2
containerOverrides:
- name: containerName2
command: [subcommand2, arg]
Installation
% go get github.com/Songmu/ecschedule/cmd/ecschedule
Quick Start
dump configuration YAML
% ecschedule dump --cluster clusterName --region us-east-1 > ecschedule.yaml
edit and adjust configuration file after it.
apply new or updated rule
% ecschedule -conf ecschedule.yaml apply -rule $ruleName
Before you apply it, you can check the diff in the following way.
% ecschedule -conf ecschedule.yaml diff -rule $ruleName
Functions
You can use following functions in the configuration file.
env- expand environment variable or using default value
{{ env "ENV_NAME" "DEFAULT_VALUE" }}
must_env- expand environment variable
{{ must_env "ENV_NAME" }}
inspired by ecspresso.
Author
Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func GetAWSAccountID ¶
GetAWSAccountID returns id
Types ¶
type BaseConfig ¶
type BaseConfig struct {
Region string `yaml:"region"`
Cluster string `yaml:"cluster"`
AccountID string `yaml:"-"`
}
BaseConfig baseconfig
type Config ¶
type Config struct {
Role string `yaml:"role,omitempty"`
*BaseConfig `yaml:",inline"`
Rules []*Rule `yaml:"rules"`
}
Config config
func LoadConfig ¶
LoadConfig loads config
func (*Config) GetRuleByName ¶
GetRuleByName gets rule by name
type ContainerOverride ¶
type ContainerOverride struct {
Name string `yaml:"name"`
Command []string `yaml:"command,flow"` // ,flow
Environment map[string]string `yaml:"environment,omitempty"`
}
ContainerOverride overrids container
type Rule ¶
type Rule struct {
Name string `yaml:"name"`
Description string `yaml:"description,omitempty"`
ScheduleExpression string `yaml:"scheduleExpression"`
Disabled bool `yaml:"disabled,omitempty"` // ENABLE | DISABLE
*Target `yaml:",inline"`
*BaseConfig `yaml:",inline,omitempty"`
}
Rule the rule
func (*Rule) PutRuleInput ¶
func (r *Rule) PutRuleInput() *cloudwatchevents.PutRuleInput
PutRuleInput puts rule input
func (*Rule) PutTargetsInput ¶
func (r *Rule) PutTargetsInput() *cloudwatchevents.PutTargetsInput
PutTargetsInput puts targets input
type Target ¶
type Target struct {
TargetID string `yaml:"targetId,omitempty"`
TaskDefinition string `yaml:"taskDefinition"`
TaskCount int64 `yaml:"taskCount,omitempty"`
ContainerOverrides []*ContainerOverride `yaml:"containerOverrides,omitempty"`
Role string `yaml:"role,omitempty"`
}
Target cluster
Source Files
¶
Directories
Click to show internal directories.
Click to hide internal directories.