Skip to content

Commit

Permalink
client/apps: removes wrong arg in flag, also adds docs about new flag…
Browse files Browse the repository at this point in the history
…s in info
  • Loading branch information
arthur committed Jul 10, 2017
1 parent 14b0ff9 commit d2f73eb
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 8 deletions.
14 changes: 7 additions & 7 deletions docs/cmds.json
Expand Up @@ -120,8 +120,8 @@
"desc": "Shows log entries for an application. These logs include everything the\napplication send to stdout and stderr, alongside with logs from tsuru server\n(deployments, restarts, etc.)\n\nThe [[--lines]] flag is optional and by default its value is 10.\n\nThe [[--source]] flag is optional and allows filtering logs by log source\n(e.g. application, tsuru api).\n\nThe [[--unit]] flag is optional and allows filtering by unit. It's useful if\nyour application has multiple units and you want logs from a single one.\n\nThe [[--follow]] flag is optional and makes the command wait for additional\nlog output\n\nThe [[--no-date]] flag is optional and makes the log output without date.\n\nThe [[--no-source]] flag is optional and makes the log output without source\ninformation, useful to very dense logs.\n\n\nFlags:\n \n -a, --app (= \"\")\n The name of the app.\n -f, --follow (= false)\n Follow logs\n -l, --lines (= 10)\n The number of log lines to display\n --no-date (= false)\n No date information\n --no-source (= false)\n No source information\n -s, --source (= \"\")\n The log from the given source\n -u, --unit (= \"\")\n The log from the given unit\n \n"
},
"app-deploy": {
"usage": "tsuru app-deploy [-a/--app <appname>] [-i/--image <image_url>] <file-or-dir-1> [file-or-dir-2] ... [file-or-dir-n]",
"desc": "Deploys set of files and/or directories to tsuru server. Some examples of\ncalls are:\n\n::\n\n $ tsuru app-deploy .\n $ tsuru app-deploy myfile.jar Procfile\n $ tsuru app-deploy mysite\n $ tsuru app-deploy -i http://registry.mysite.com:5000/image-name\n\n\nFlags:\n \n -a, --app (= \"\")\n The name of the app.\n -i, --image (= \"\")\n The image to deploy in app\n -m, --message (= \"\")\n A message describing this deploy\n \n"
"usage": "tsuru app-deploy [-a/--app <appname>] [-i/--image <image_url>] [-m/--message <message>] <file-or-dir-1> [file-or-dir-2] ... [file-or-dir-n]",
"desc": "Deploys set of files and/or directories to tsuru server. Some examples of\ncalls are:\n\n::\n\n $ tsuru app-deploy .\n $ tsuru app-deploy myfile.jar Procfile\n $ tsuru app-deploy mysite\n $ tsuru app-deploy -i http://registry.mysite.com:5000/image-name\n\n\nFlags:\n \n -a, --app (= \"\")\n The name of the app.\n -i, --image (= \"\")\n The image to deploy in app\n -m, --message (= \"\")\n A message describing this deploy\n -s, --single-files (= false)\n enables single file deployment\n \n"
},
"app-deploy-rebuild": {
"usage": "tsuru app-deploy-rebuild [-a/--app appname]",
Expand Down Expand Up @@ -256,8 +256,8 @@
"desc": "Creates a new machine template.\n\nTemplates can be used with the [[docker-node-add]] command running it with\nthe [[template=<template name>]] parameter. Templates can contain a list of\nparameters that will be sent to the IaaS provider.\n\nMinimum # of arguments: 3\n"
},
"app-update": {
"usage": "tsuru app-update [-a/--app appname] [--description/-d description] [--plan/-p plan name] [--router/-r router name] [--pool/-o pool] [--team-owner/-t team owner] [-i/--image-reset] [--tag/-g tag]... [--router-opts key=value]...",
"desc": "Updates an app, changing its description, tags, plan or pool information.\n\nThe [[--description]] parameter sets a description for your app.\n\nThe [[--plan]] parameter changes the plan of your app.\n\nThe [[--router]] parameter changes the router of your app.\n\nThe [[--pool]] parameter changes the pool of your app.\n\nThe [[--team-owner]] parameter sets owner team for an application.\n\nThe [[--tag]] parameter sets a tag for your app. You can set\nmultiple [[--tag]] parameters.\n\nThe [[--router-opts]] parameter changes the custom router parameters.\n\nFlags:\n \n -a, --app (= \"\")\n The name of the app.\n -d, --description (= \"\")\n App description\n -g, --tag (= [])\n App tag\n -i, --image-reset (= false)\n Forces next deploy to build app image from scratch\n -o, --pool (= \"\")\n App pool\n -p, --plan (= \"\")\n App plan\n -r, --router (= \"\")\n App router\n --router-opts (= {})\n Router options\n -t, --team-owner (= \"\")\n App team owner\n \n"
"usage": "tsuru app-update [-a/--app appname] [--description/-d description] [--plan/-p plan name] [--router/-r router name] [--pool/-o pool] [--team-owner/-t team owner] [--platform/-l platform] [-i/--image-reset image] [--tag/-g tag]... [--router-opts key=value]...",
"desc": "Updates an app, changing its description, tags, plan or pool information.\n\nThe [[--description]] parameter sets a description for your app.\n\nThe [[--plan]] parameter changes the plan of your app.\n\nThe [[--router]] parameter changes the router of your app.\n\nThe [[--pool]] parameter changes the pool of your app.\n\nThe [[--team-owner]] parameter sets owner team for an application.\n\nThe [[--tag]] parameter sets a tag for your app. You can set\nmultiple [[--tag]] parameters.\n\nThe [[--router-opts]] parameter changes the custom router parameters.\n\nFlags:\n \n -a, --app (= \"\")\n The name of the app.\n -d, --description (= \"\")\n App description\n -g, --tag (= [])\n App tag\n -i, --image-reset (= false)\n Forces next deploy to build app image from scratch\n -l, --platform (= \"\")\n App platform\n -o, --pool (= \"\")\n App pool\n -p, --plan (= \"\")\n App plan\n -r, --router (= \"\")\n App router\n --router-opts (= {})\n Router options\n -t, --team-owner (= \"\")\n App team owner\n \n"
},
"role-dissociate": {
"usage": "tsuru role-dissociate <role-name> <user-email> [<context-value>]",
Expand Down Expand Up @@ -388,15 +388,15 @@
"desc": "Installs Tsuru and It's components as containers on hosts provisioned\nwith docker machine drivers.\n\nThe [[--config]] parameter is the path to a .yml file containing the installation\nconfiguration. If not provided, Tsuru will be installed into a VirtualBox VM for\nexperimentation.\n\n\nFlags:\n \n -c, --config (= \"\")\n Configuration file\n -e, --compose (= \"\")\n Components docker-compose file\n \n"
},
"app-create": {
"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"
"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: 1\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 Down
6 changes: 5 additions & 1 deletion tsuru/client/apps.go
Expand Up @@ -226,7 +226,7 @@ type AppUpdate struct {
func (c *AppUpdate) Info() *cmd.Info {
return &cmd.Info{
Name: "app-update",
Usage: "app-update [-a/--app appname] [--description/-d description] [--plan/-p plan name] [--router/-r router name] [--pool/-o pool] [--team-owner/-t team owner] [--platform/-l platform] [-i/--image-reset image] [--tag/-g tag]... [--router-opts key=value]...",
Usage: "app-update [-a/--app appname] [--description/-d description] [--plan/-p plan name] [--router/-r router name] [--pool/-o pool] [--team-owner/-t team owner] [--platform/-l platform] [-i/--image-reset] [--tag/-g tag]... [--router-opts key=value]...",
Desc: `Updates an app, changing its description, tags, plan or pool information.
The [[--description]] parameter sets a description for your app.
Expand All @@ -239,6 +239,10 @@ The [[--pool]] parameter changes the pool of your app.
The [[--team-owner]] parameter sets owner team for an application.
The [[--platform]] parameter sets a platform for an application.
The [[--image-reset]] parameter rebuilds the platform of an application.
The [[--tag]] parameter sets a tag for your app. You can set
multiple [[--tag]] parameters.
Expand Down

0 comments on commit d2f73eb

Please sign in to comment.