UNPKG

22.2 kBJSONView Raw
1{"version":"7.18.9","commands":{"spaces":{"id":"spaces","description":"list available spaces\n","pluginName":"@heroku-cli/plugin-spaces","pluginType":"core","hidden":false,"aliases":[],"flags":{"json":{"name":"json","type":"boolean","description":"output in json format","required":false,"allowNo":false},"team":{"name":"team","type":"option","char":"t","description":"team to use","hidden":false,"required":false},"org":{"name":"org","type":"option","char":"o","description":"team to use","hidden":true}},"args":[]},"spaces:create":{"id":"spaces:create","description":"create a new space\nExample:\n\n $ heroku spaces:create --space my-space --team my-team --region oregon\n Creating space my-space in team my-team... done\n === my-space\n ID: e7b99e37-69b3-4475-ad47-a5cc5d75fd9f\n Team: my-team\n Region: oregon\n CIDR: 10.0.0.0/16\n Data CIDR: 172.23.0.0/20\n State: allocating\n Created at: 2016-01-06T03:23:13Z\n\n ","pluginName":"@heroku-cli/plugin-spaces","pluginType":"core","hidden":false,"aliases":[],"flags":{"space":{"name":"space","type":"option","char":"s","description":"name of space to create","required":false},"channel":{"name":"channel","type":"option","hidden":true,"required":false},"region":{"name":"region","type":"option","description":"region name","required":false},"features":{"name":"features","type":"option","description":"a list of features separated by commas","hidden":true,"required":false},"log-drain-url":{"name":"log-drain-url","type":"option","description":"direct log drain url","hidden":true,"required":false},"owner-pool":{"name":"owner-pool","type":"option","description":"owner pool name","hidden":true,"required":false},"shield":{"name":"shield","type":"boolean","description":"create a Shield space","hidden":true,"required":false,"allowNo":false},"cidr":{"name":"cidr","type":"option","description":"RFC-1918 CIDR the space will use","required":false},"kpi-url":{"name":"kpi-url","type":"option","description":"self-managed KPI endpoint to use","hidden":true,"required":false},"data-cidr":{"name":"data-cidr","type":"option","description":"RFC-1918 CIDR used by Heroku Data resources for the space","required":false},"team":{"name":"team","type":"option","char":"t","description":"team to use","hidden":false,"required":false},"org":{"name":"org","type":"option","char":"o","description":"team to use","hidden":true}},"args":[{"name":"space","required":false,"hidden":true}]},"spaces:destroy":{"id":"spaces:destroy","description":"destroy a space\nExample:\n\n $ heroku spaces:destroy --space my-space\n Destroying my-space... done\n","pluginName":"@heroku-cli/plugin-spaces","pluginType":"core","hidden":false,"aliases":[],"flags":{"space":{"name":"space","type":"option","char":"s","description":"space to destroy","required":false},"confirm":{"name":"confirm","type":"option","description":"set to space name to bypass confirm prompt","required":false}},"args":[{"name":"space","required":false,"hidden":true}]},"spaces:info":{"id":"spaces:info","description":"show info about a space\n","pluginName":"@heroku-cli/plugin-spaces","pluginType":"core","hidden":false,"aliases":[],"flags":{"space":{"name":"space","type":"option","char":"s","description":"space to get info of","required":false},"json":{"name":"json","type":"boolean","description":"output in json format","required":false,"allowNo":false}},"args":[{"name":"space","required":false,"hidden":true}]},"spaces:rename":{"id":"spaces:rename","description":"renames a space\nExample:\n\n $ heroku spaces:rename --from old-space-name --to new-space-name\n Renaming space old-space-name to new-space-name... done\n","pluginName":"@heroku-cli/plugin-spaces","pluginType":"core","hidden":false,"aliases":[],"flags":{"from":{"name":"from","type":"option","description":"current name of space","required":true},"to":{"name":"to","type":"option","description":"desired name of space","required":true}},"args":[]},"spaces:wait":{"id":"spaces:wait","description":"wait for a space to be created\n","pluginName":"@heroku-cli/plugin-spaces","pluginType":"core","hidden":false,"aliases":[],"flags":{"space":{"name":"space","type":"option","char":"s","description":"space to get info of","required":false},"json":{"name":"json","type":"boolean","description":"output in json format","required":false,"allowNo":false},"interval":{"name":"interval","type":"option","char":"i","description":"seconds to wait between poll intervals","required":false},"timeout":{"name":"timeout","type":"option","char":"t","description":"maximum number of seconds to wait","required":false}},"args":[{"name":"space","required":false,"hidden":true}]},"spaces:peering:info":{"id":"spaces:peering:info","description":"display the information necessary to initiate a peering connection\nExample:\n\n $ heroku spaces:peering:info example-space\n === example-space Peering Info\n AWS Account ID: 012345678910\n AWS Region: us-west-2\n AWS VPC ID: vpc-baadf00d\n AWS VPC CIDR: 10.0.0.0/16\n Space CIDRs: 10.0.128.0/20, 10.0.144.0/20\n Unavailable CIDRs: 10.1.0.0/16\n\nYou will use the information provied by this command to establish a peering connection request from your AWS VPC to your private space.\n\nTo start the peering process, go into your AWS console for the VPC you would like peered with your Private Space,\nnavigate to the VPC service, choose the \"Peering Connections\" option and click the \"Create peering connection\" button.\n\n- The AWS Account ID and VPC ID are necessary for the AWS VPC Peering connection wizard.\n- You will also need to configure your VPC route table to route the Dyno CIDRs through the peering connection.\n\nOnce you've established the peering connection request, you can use the spaces:peerings:accept command to accept and\nconfigure the peering connection for the space.\n ","pluginName":"@heroku-cli/plugin-spaces","pluginType":"core","hidden":false,"aliases":[],"flags":{"space":{"name":"space","type":"option","char":"s","description":"space to get peering info from","required":false},"json":{"name":"json","type":"boolean","description":"output in json format","required":false,"allowNo":false}},"args":[{"name":"space","required":false,"hidden":true}]},"spaces:peerings":{"id":"spaces:peerings","description":"list peering connections for a space\n","pluginName":"@heroku-cli/plugin-spaces","pluginType":"core","hidden":false,"aliases":[],"flags":{"space":{"name":"space","type":"option","char":"s","description":"space to get peer list from","required":false},"json":{"name":"json","type":"boolean","description":"output in json format","required":false,"allowNo":false}},"args":[{"name":"space","required":false,"hidden":true}]},"spaces:peerings:accept":{"id":"spaces:peerings:accept","description":"accepts a pending peering request for a private space\nExample:\n\n $ heroku spaces:peerings:accept pcx-4bd27022 --space example-space\n Accepting and configuring peering connection pcx-4bd27022\n ","pluginName":"@heroku-cli/plugin-spaces","pluginType":"core","hidden":false,"aliases":[],"flags":{"pcxid":{"name":"pcxid","type":"option","char":"p","description":"PCX ID of a pending peering","required":false},"space":{"name":"space","type":"option","char":"s","description":"space to get peering info from","required":false}},"args":[{"name":"pcxid","required":false,"hidden":true}]},"spaces:peerings:destroy":{"id":"spaces:peerings:destroy","description":"destroys an active peering connection in a private space\nExample:\n\n $ heroku spaces:peerings:destroy pcx-4bd27022 --confirm pcx-4bd27022 --space example-space\n Tearing down peering connection pcx-4bd27022\n ","pluginName":"@heroku-cli/plugin-spaces","pluginType":"core","hidden":false,"aliases":[],"flags":{"pcxid":{"name":"pcxid","type":"option","char":"p","description":"PCX ID of a pending peering","required":false},"space":{"name":"space","type":"option","char":"s","description":"space to get peering info from","required":false},"confirm":{"name":"confirm","type":"option","description":"set to PCX ID to bypass confirm prompt","required":false}},"args":[{"name":"pcxid","required":false,"hidden":true}]},"spaces:vpn:connect":{"id":"spaces:vpn:connect","description":"create VPN\nPrivate Spaces can be connected to another private network via an IPSec VPN connection allowing dynos to connect to hosts on your private networks and vice versa.\nThe connection is established over the public Internet but all traffic is encrypted using IPSec.","pluginName":"@heroku-cli/plugin-spaces","pluginType":"core","hidden":false,"aliases":[],"examples":"$ heroku spaces:vpn:connect --name office --ip 35.161.69.30 --cidrs 172.16.0.0/16,10.0.0.0/24 --space my-space\n Creating VPN Connection in space my-space... done\n ▸ Use spaces:vpn:wait to track allocation.\n ","flags":{"name":{"name":"name","type":"option","char":"n","description":"VPN name","required":false},"ip":{"name":"ip","type":"option","char":"i","description":"public IP of customer gateway","required":false},"cidrs":{"name":"cidrs","type":"option","char":"c","description":"a list of routable CIDRs separated by commas","required":false},"space":{"name":"space","type":"option","char":"s","description":"space name","required":false}},"args":[{"name":"name","required":false,"hidden":true}]},"spaces:vpn:connections":{"id":"spaces:vpn:connections","description":"list the VPN Connections for a space\nExample:\n\n $ heroku spaces:vpn:connections --space my-space\n === my-space VPN Connections\n Name Status Tunnels\n ────── ────── ───────\n office active UP/UP\n ","pluginName":"@heroku-cli/plugin-spaces","pluginType":"core","hidden":false,"aliases":[],"flags":{"space":{"name":"space","type":"option","char":"s","description":"space to get VPN connections from","required":false},"json":{"name":"json","type":"boolean","description":"output in json format","required":false,"allowNo":false}},"args":[{"name":"space","required":false,"hidden":true}]},"spaces:vpn:info":{"id":"spaces:vpn:info","description":"display the information for VPN\nExample:\n\n $ heroku spaces:vpn:info --space my-space vpn-connection-name\n === vpn-connection-name VPN Tunnel Info\n Name: vpn-connection-name\n ID: 123456789012\n Public IP: 35.161.69.30\n Routable CIDRs: 172.16.0.0/16\n Status: failed\n Status Message: supplied CIDR block already in use\n === my-space Tunnel Info\n VPN Tunnel IP Address Status Status Last Changed Details\n ────────── ───────────── ────── ──────────────────── ──────────────\n Tunnel 1 52.44.146.197 UP 2016-10-25T22:09:05Z status message\n Tunnel 2 52.44.146.197 UP 2016-10-25T22:09:05Z status message","pluginName":"@heroku-cli/plugin-spaces","pluginType":"core","hidden":false,"aliases":[],"flags":{"space":{"name":"space","type":"option","char":"s","description":"space the vpn connection belongs to","required":false},"json":{"name":"json","type":"boolean","description":"output in json format","required":false,"allowNo":false},"name":{"name":"name","type":"option","char":"n","description":"name or id of the VPN connection to get info from","required":false}},"args":[{"name":"name","required":false,"hidden":true}]},"spaces:vpn:config":{"id":"spaces:vpn:config","description":"display the configuration information for VPN\nExample:\n\n $ heroku spaces:vpn:config --space my-space vpn-connection-name\n === vpn-connection-name VPN Tunnels\n VPN Tunnel Customer Gateway VPN Gateway Pre-shared Key Routable Subnets IKE Version\n ────────── ──────────────── ────────────── ────────────── ──────────────── ───────────\n Tunnel 1 104.196.121.200 35.171.237.136 abcdef12345 10.0.0.0/16 1\n Tunnel 2 104.196.121.200 52.44.7.216 fedcba54321 10.0.0.0/16 1\n\nYou will use the information provided by this command to establish a Private Space VPN Connection.\n\n- You must configure your VPN Gateway to use both Tunnels provided by Heroku\n- The VPN Gateway values are the IP addresses of the Private Space Tunnels\n- The Customer Gateway value is the Public IP of your VPN Gateway\n- The VPN Gateway must use the IKE Version shown and the Pre-shared Keys as the authentication method\n","pluginName":"@heroku-cli/plugin-spaces","pluginType":"core","hidden":false,"aliases":[],"flags":{"space":{"name":"space","type":"option","char":"s","description":"space the VPN connection belongs to","required":false},"name":{"name":"name","type":"option","char":"n","description":"name or id of the VPN connection to retrieve config from","required":false},"json":{"name":"json","type":"boolean","description":"output in json format","required":false,"allowNo":false}},"args":[{"name":"name","required":false,"hidden":true}]},"spaces:vpn:wait":{"id":"spaces:vpn:wait","description":"wait for VPN Connection to be created\n","pluginName":"@heroku-cli/plugin-spaces","pluginType":"core","hidden":false,"aliases":[],"flags":{"space":{"name":"space","type":"option","char":"s","description":"space the vpn connection belongs to","required":false},"name":{"name":"name","type":"option","char":"n","description":"name or id of the vpn connection to wait for","required":false},"json":{"name":"json","type":"boolean","description":"output in json format","required":false,"allowNo":false},"interval":{"name":"interval","type":"option","char":"i","description":"seconds to wait between poll intervals","required":false},"timeout":{"name":"timeout","type":"option","char":"t","description":"maximum number of seconds to wait","required":false}},"args":[{"name":"name","required":false,"hidden":true}]},"spaces:vpn:destroy":{"id":"spaces:vpn:destroy","description":"destroys VPN in a private space\nExample:\n\n $ heroku spaces:vpn:destroy --space example-space vpn-connection-name --confirm vpn-connection-name\n Tearing down VPN Connection vpn-connection-name in space example-space\n ","pluginName":"@heroku-cli/plugin-spaces","pluginType":"core","hidden":false,"aliases":[],"flags":{"space":{"name":"space","type":"option","char":"s","description":"space to get peering info from","required":false},"name":{"name":"name","type":"option","char":"n","description":"name or id of the VPN connection to retrieve config from","required":false},"confirm":{"name":"confirm","type":"option","description":"set to VPN connection name to bypass confirm prompt","required":false}},"args":[{"name":"name","required":false,"hidden":true}]},"spaces:ps":{"id":"spaces:ps","description":"list dynos for a space\n","pluginName":"@heroku-cli/plugin-spaces","pluginType":"core","hidden":false,"aliases":[],"flags":{"space":{"name":"space","type":"option","char":"s","description":"space to get dynos of","required":false},"json":{"name":"json","type":"boolean","description":"output in json format","required":false,"allowNo":false}},"args":[{"name":"space","required":false,"hidden":true}]},"spaces:topology":{"id":"spaces:topology","description":"show space topology\n","pluginName":"@heroku-cli/plugin-spaces","pluginType":"core","hidden":false,"aliases":[],"flags":{"space":{"name":"space","type":"option","char":"s","description":"space to get topology of","required":false},"json":{"name":"json","type":"boolean","description":"output in json format","required":false,"allowNo":false}},"args":[{"name":"space","required":false,"hidden":true}]},"drains:get":{"id":"drains:get","description":"display the log drain for a space\n","pluginName":"@heroku-cli/plugin-spaces","pluginType":"core","hidden":true,"aliases":[],"flags":{"space":{"name":"space","type":"option","char":"s","description":"space for which to get log drain","required":true},"json":{"name":"json","type":"boolean","description":"output in json format","required":false,"allowNo":false}},"args":[]},"drains:set":{"id":"drains:set","description":"replaces the log drain for a space\n","pluginName":"@heroku-cli/plugin-spaces","pluginType":"core","hidden":true,"aliases":[],"flags":{"space":{"name":"space","type":"option","char":"s","description":"space for which to set log drain","required":true}},"args":[{"name":"url","required":true}]},"trusted-ips":{"id":"trusted-ips","description":"list trusted IP ranges for a space\n\nTrusted IP ranges are only available on Private Spaces.\n\nThe space name is a required parameter. Newly created spaces will have 0.0.0.0/0 set by default\nallowing all traffic to applications in the space. More than one CIDR block can be provided at\na time to the commands listed below. For example 1.2.3.4/20 and 5.6.7.8/20 can be added with:\n ","pluginName":"@heroku-cli/plugin-spaces","pluginType":"core","hidden":false,"aliases":[],"flags":{"space":{"name":"space","type":"option","char":"s","description":"space to get inbound rules from","required":false},"json":{"name":"json","type":"boolean","description":"output in json format","required":false,"allowNo":false}},"args":[{"name":"space","required":false,"hidden":true}]},"trusted-ips:add":{"id":"trusted-ips:add","description":"Add one range to the list of trusted IP ranges\n\nUses CIDR notation.\n\nExample:\n\n $ heroku trusted-ips:add --space my-space 192.168.2.0/24\n Added 192.168.0.1/24 to trusted IP ranges on my-space\n ","pluginName":"@heroku-cli/plugin-spaces","pluginType":"core","hidden":false,"aliases":[],"flags":{"space":{"name":"space","type":"option","char":"s","description":"space to add rule to","required":false},"confirm":{"name":"confirm","type":"option","description":"set to space name to bypass confirm prompt","required":false}},"args":[{"name":"source","required":true}]},"trusted-ips:remove":{"id":"trusted-ips:remove","description":"Remove a range from the list of trusted IP ranges\n\nUses CIDR notation.\n\nExample:\n\n $ heroku trusted-ips:remove --space my-space 192.168.2.0/24\n Removed 192.168.2.0/24 from trusted IP ranges on my-space\n ","pluginName":"@heroku-cli/plugin-spaces","pluginType":"core","hidden":false,"aliases":[],"flags":{"space":{"name":"space","type":"option","description":"space to remove rule from","required":true},"confirm":{"name":"confirm","type":"option","description":"set to space name to bypass confirm prompt","required":false}},"args":[{"name":"source","required":true}]},"outbound-rules":{"id":"outbound-rules","description":"list Outbound Rules for a space\n\nOutbound Rules are only available on Private Spaces.\n\nNewly created spaces will have an \"Allow All\" rule set by default\nallowing all egress dyno traffic outside of the space. You can\nremove this default rule to completely stop your private dynos from\ntalking to the world.\n\nYou can add specific rules that only allow your dyno to communicate with trusted hosts.\n ","pluginName":"@heroku-cli/plugin-spaces","pluginType":"core","hidden":true,"aliases":[],"flags":{"space":{"name":"space","type":"option","char":"s","description":"space to get outbound rules from","required":false},"json":{"name":"json","type":"boolean","description":"output in json format","required":false,"allowNo":false}},"args":[{"name":"space","required":false,"hidden":true}]},"outbound-rules:add":{"id":"outbound-rules:add","description":"Add outbound rules to a Private Space\n\nThe destination flag uses CIDR notation.\n\n Example:\n\n $ heroku outbound-rules:add --space my-space --dest 192.168.2.0/24 --protocol tcp --port 80\n Added 192.168.0.1/24 to the outbound rules on my-space\n\n Example with port range:\n\n $ heroku outbound-rules:add --space my-space --dest 192.168.2.0/24 --protocol tcp --port 80-100\n Added 192.168.0.1/24 to the outbound rules on my-space\n\n Example opening up everything\n\n $ heroku outbound-rules:add --space my-space --dest 0.0.0.0/0 --protocol any --port any\n Added 0.0.0.0/0 to the outbound rules on my-space\n\nICMP Rules\nThe ICMP protocol has types, not ports, but the underlying systems treat them as the same. For this reason,\nwhen you want to allow ICMP traffic you will use the --port flag to specify the ICMP types you want to\nallow. ICMP types are numbered, 0-255.\n ","pluginName":"@heroku-cli/plugin-spaces","pluginType":"core","hidden":true,"aliases":[],"flags":{"space":{"name":"space","type":"option","char":"s","description":"space to add rule to","required":false},"confirm":{"name":"confirm","type":"option","description":"set to space name to bypass confirm prompt","required":false},"dest":{"name":"dest","type":"option","description":"target CIDR block dynos are allowed to communicate with","required":false},"protocol":{"name":"protocol","type":"option","description":"the protocol dynos are allowed to use when communicating with hosts in destination CIDR block. Valid protocols are \"tcp\", \"udp\", \"icmp\", \"0-255\" and \"any\".","required":false},"port":{"name":"port","type":"option","description":"the port dynos are allowed to use when communicating with hosts in destination CIDR block. Accepts a range in `<lowest port>-<highest port>` format. 0 is the minimum. The maximum port allowed is 65535, except for ICMP with a maximum of 255.","required":false}},"args":[]},"outbound-rules:remove":{"id":"outbound-rules:remove","description":"Remove a Rules from the list of Outbound Rules\nExample:\n\n $ heroku outbound-rules:remove --space my-space 4\n Removed 192.168.2.0/24 from trusted IP ranges on my-space\n ","pluginName":"@heroku-cli/plugin-spaces","pluginType":"core","hidden":true,"aliases":[],"flags":{"space":{"name":"space","type":"option","description":"space to remove rule from","required":true},"confirm":{"name":"confirm","type":"option","description":"set to space name to bypass confirm prompt","required":false}},"args":[{"name":"ruleNumber","required":true}]}}}
\No newline at end of file