Skip to content

Commit

Permalink
events: renames event-block cmds for better alignment with topics
Browse files Browse the repository at this point in the history
  • Loading branch information
andrestc committed Jun 8, 2017
1 parent 18af8dd commit 7ce25f3
Show file tree
Hide file tree
Showing 3 changed files with 22 additions and 16 deletions.
22 changes: 11 additions & 11 deletions docs/cmds.json
Expand Up @@ -167,10 +167,6 @@
"usage": "tsuru bs-info",
"desc": "This command was removed. You should use `tsuru node-container-info big-sibling` instead.\n\n"
},
"event-unblock": {
"usage": "tsuru event-block <ID>",
"desc": "Unblock event.\n\nMinimum # of arguments: 1\nMaximum # of arguments: 1\n"
},
"service-update": {
"usage": "tsuru service-update <path/to/manifest>",
"desc": "Update service data, extracting it from the given manifest file.\n\nMinimum # of arguments: 1\n"
Expand All @@ -191,6 +187,10 @@
"usage": "tsuru plugin-remove <plugin-name>",
"desc": "Removes a previously installed tsuru plugin.\n\nMinimum # of arguments: 1\n"
},
"event-block-remove": {
"usage": "tsuru event-block-remove <ID>",
"desc": "Removes an event block.\n\nMinimum # of arguments: 1\nMaximum # of arguments: 1\n"
},
"certificate-list": {
"usage": "tsuru certificate-list [-a/--app appname] [-r/--raw]",
"desc": "List App TLS certificates.\n\nFlags:\n \n -a, --app (= \"\")\n The name of the app.\n -r, --raw (= false)\n Display raw certificates\n \n"
Expand Down Expand Up @@ -391,8 +391,12 @@
"usage": "tsuru app-create <appname> <platform> [--plan/-p plan name] [--router/-r router name] [--team/-t team owner] [--pool/-o pool name] [--description/-d description] [--tag/-g tag]... [--router-opts key=value]...",
"desc": "Creates a new app using the given name and platform. For tsuru,\na platform is provisioner dependent. To check the available platforms, use the\ncommand [[tsuru platform-list]] and to add a platform use the command [[tsuru platform-add]].\n\nIn order to create an app, you need to be member of at least one team. All\nteams that you are member (see [[tsuru team-list]]) will be able to access the\napp.\n\nThe [[--platform]] parameter is the name of the platform to be used when\ncreating the app. This will define how tsuru understands and executes your\napp. The list of available platforms can be found running [[tsuru platform-list]].\n\nThe [[--plan]] parameter defines the plan to be used. The plan specifies how\ncomputational resources are allocated to your application. Typically this\nmeans limits for memory and swap usage, and how much cpu share is allocated.\nThe list of available plans can be found running [[tsuru plan-list]].\n\nIf this parameter is not informed, tsuru will choose the plan with the\n[[default]] flag set to true.\n\nThe [[--router]] parameter defines the router to be used. The list of available\nrouters can be found running [[tsuru router-list]].\n\nIf this parameter is not informed, tsuru will choose the router with the\n[[default]] flag set to true.\n\nThe [[--team]] parameter describes which team is responsible for the created\napp, this is only needed if the current user belongs to more than one team, in\nwhich case this parameter will be mandatory.\n\nThe [[--pool]] parameter defines which pool your app will be deployed.\nThis is only needed if you have more than one pool associated with your teams.\n\nThe [[--description]] parameter sets a description for your app.\nIt is an optional parameter, and if its not set the app will only not have a\ndescription associated.\n\nThe [[--tag]] parameter sets a tag to your app. You can set multiple [[--tag]] parameters.\n\nThe [[--router-opts]] parameter allow passing custom parameters to the router\nused by the application's plan. The key and values used depends on the router\nimplementation.\n\nFlags:\n \n -d, --description (= \"\")\n App description\n -g, --tag (= [])\n App tag\n -o, --pool (= \"\")\n Pool to deploy your app\n -p, --plan (= \"\")\n The plan used to create the app\n -r, --router (= \"\")\n The router used by the app\n --router-opts (= {})\n Router options\n -t, --team (= \"\")\n Team owner app\n \nMinimum # of arguments: 2\n"
},
"event-block-add": {
"usage": "tsuru event-block-add <reason> [-k/--kind kindName] [-o/--owner ownerName] [-t/--target targetType] [-v/--value targetValue]",
"desc": "Block events.\n\nFlags:\n \n -k, --kind (= \"\")\n Event kind to be blocked.\n -o, --owner (= \"\")\n Block this owner's events.\n -t, --target (= \"\")\n Block events with this target type.\n -v, --value (= \"\")\n Block events with this target value.\n \nMinimum # of arguments: 1\n"
},
"role-default-remove": {
"usage": "tsuru role-default-remove [--user-create <role name>]... [--team-create <role name>]...",
"usage": "tsuru role-default-remove [--team-create <role name>]... [--user-create <role name>]...",
"desc": "Remove a default role from a specific event.\n\nFlags:\n \n --team-create (= [])\n role added to user when a new team is created\n --user-create (= [])\n role added to user when user is created\n \n"
},
"node-remove": {
Expand All @@ -404,7 +408,7 @@
"desc": "Display the current configuration for tsuru autoscale,\nincluding the set of rules and the current metadata filter.\n\nThe metadata filter is the value that defines which node metadata will be used\nto group autoscale rules. A common approach is to use the \"pool\" as the\nfilter. Then autoscale can be configured for each matching rule value.\n\n"
},
"target": {
"topic": "In tsuru, a target is the address of the remote tsuru server.\n\nEach target is identified by a label and a HTTP/HTTPS address. The client\nrequires at least one target to connect to, there's no default target. A user\nmay have multiple targets, but he/she will be able to use only per session."
"topic": "Target is used to manage the address of the remote tsuru server.\n\nEach target is identified by a label and a HTTP/HTTPS address. The client\nrequires at least one target to connect to, there's no default target. A user\nmay have multiple targets, but only one will be used at a time."
},
"pool-remove": {
"usage": "tsuru pool-remove <pool> [-y]",
Expand Down Expand Up @@ -590,10 +594,6 @@
"usage": "tsuru service-list",
"desc": "Retrieves and shows a list of services the user has access. If there are\ninstances created for any service they will also be shown.\n\n"
},
"event-block": {
"usage": "tsuru event-block <reason> [-k/--kind kindName] [-o/--owner ownerName] [-t/--target targetType] [-v/--value targetValue]",
"desc": "Block events.\n\nFlags:\n \n -k, --kind (= \"\")\n Event kind to be blocked.\n -o, --owner (= \"\")\n Block this owner's events.\n -t, --target (= \"\")\n Block events with this target type.\n -v, --value (= \"\")\n Block events with this target value.\n \nMinimum # of arguments: 1\n"
},
"key-remove": {
"usage": "tsuru key-remove <key-name> [-y/--assume-yes]",
"desc": "Removes your public key from the git server used by tsuru. The key will be\nremoved from the current logged in user.\n\nFlags:\n \n -y, --assume-yes (= false)\n Don't ask for confirmation.\n \nMinimum # of arguments: 1\n"
Expand All @@ -602,4 +602,4 @@
"usage": "tsuru pool-list",
"desc": "List all pools available for deploy.\n\n"
}
}
}
6 changes: 6 additions & 0 deletions docs/source/reference.rst
Expand Up @@ -287,6 +287,12 @@ Events
.. tsuru-command:: event-cancel
:title: Cancel an event

.. tsuru-command:: event-block-add
:title: Adds an event block

.. tsuru-command:: event-block-remove
:title: Removes an event block

Container management
====================

Expand Down
10 changes: 5 additions & 5 deletions tsuru/admin/event.go
Expand Up @@ -104,8 +104,8 @@ type EventBlockAdd struct {

func (c *EventBlockAdd) Info() *cmd.Info {
return &cmd.Info{
Name: "event-block",
Usage: "event-block <reason> [-k/--kind kindName] [-o/--owner ownerName] [-t/--target targetType] [-v/--value targetValue]",
Name: "event-block-add",
Usage: "event-block-add <reason> [-k/--kind kindName] [-o/--owner ownerName] [-t/--target targetType] [-v/--value targetValue]",
Desc: "Block events.",
MinArgs: 1,
}
Expand Down Expand Up @@ -162,9 +162,9 @@ type EventBlockRemove struct{}

func (c *EventBlockRemove) Info() *cmd.Info {
return &cmd.Info{
Name: "event-unblock",
Usage: "event-block <ID>",
Desc: "Unblock event.",
Name: "event-block-remove",
Usage: "event-block-remove <ID>",
Desc: "Removes an event block.",
MinArgs: 1,
MaxArgs: 1,
}
Expand Down

0 comments on commit 7ce25f3

Please sign in to comment.