rack

Get information about the rack

Usage

    convox rack

Examples

    $ convox rack
    Name      test
    Provider  aws
    Router    router.0a1b2c3d4e5f.convox.cloud
    Status    running
    Version   3.0.0

rack install

Install a new Rack

note: To install the rack into the console with the specified runtime, region, and optional parameters: provide orgname/rackname in place of <name>

Usage

    convox rack install <provider> <name> [option=value]...

    convox rack install <provider> <orgname>/<rackname> region=<region> --runtime=<runtime-id> [option=value]...

flags:

runtime: runtime integration ID
version: specify the rack version to install

note: To install a rack into an organization with runtime integration, ensure your CLI is updated to the latest version. For detailed instructions on updating CLI, please see CLI Management.

note: Obtain the runtime ID by running convox runtimes <orgname>.

Examples

    $ convox rack install local dev
    ...

    $ convox rack install aws production region=eu-west-1 node_type=t3.large
    ...

    $ convox rack install aws my-org/staging region=us-east-1 --runtime=20e58437-fab7-4124-aa5a-2e5978f1149e
    ...

rack kubeconfig

Output a Kubernetes configuration file for connecting to the underlying cluster

Usage

    convox rack kubeconfig

Examples

    $ convox rack kubeconfig
    apiVersion: v1
    clusters:
    - cluster:
        server: https://api.0a1b2c3d4e5f.convox.cloud/kubernetes/
    name: kubernetes
    contexts:
    - context:
        cluster: kubernetes
        user: proxy
    name: proxy@kubernetes
    current-context: proxy@kubernetes
    kind: Config
    preferences: {}
    users:
    - name: proxy
    user:
        username: convox
        password: abcdefghijklmnopqrstuvwxyz

rack logs

Get logs for the rack

Usage

    convox rack logs

Examples

    $ convox rack logs
    2020-02-10T13:37:22Z service/web/a55eb25e-90f5-4301-99fd-e35c91128592 ns=provider.aws at=SystemGet state=success elapsed=275.683
    2020-02-10T13:37:22Z service/web/a55eb25e-90f5-4301-99fd-e35c91128592 id=8d3ec85dc324 ns=api at=SystemGet method="GET" path="/system" response=200 elapsed=276.086
    2020-02-10T13:38:04Z service/web/a55eb25e-90f5-4301-99fd-e35c91128592 ns=provider.aws at=SystemGet state=success elapsed=331.824
    2020-02-10T13:38:04Z service/web/a55eb25e-90f5-4301-99fd-e35c91128592 id=f492a0dce931 ns=api at=SystemGet method="GET" path="/system" response=200 elapsed=332.219
    ...

rack mv

Transfer the management of a Rack from an individual user to an organization or vice versa.

note: rack name should be same

Usage

    convox rack mv <from> <to>

Examples

    $ convox rack mv dev acme/dev
    moving rack dev to acme/dev... OK

    $ convox rack mv acme/dev dev
    moving rack acme/dev to dev... OK

rack ps

List rack processes

Usage

    convox rack ps

Examples

    $ convox rack ps
    ID                       APP     SERVICE        STATUS   RELEASE       STARTED      COMMAND
    api-9749b7ccb-29zh5      system  api            running  3.0.0.beta44  2 weeks ago  api
    api-9749b7ccb-29zh5      rack    api            running  3.0.0.beta44  2 weeks ago  api
    api-9749b7ccb-cg4hr      system  api            running  3.0.0.beta44  2 weeks ago  api
    api-9749b7ccb-cg4hr      rack    api            running  3.0.0.beta44  2 weeks ago  api
    atom-578cd48bfb-6tm7g    rack    atom           running  3.0.0.beta44  2 weeks ago  atom
    atom-578cd48bfb-6tm7g    system  atom           running  3.0.0.beta44  2 weeks ago  atom
    router-846b84d544-ndz76  rack    router         running  3.0.0.beta44  2 weeks ago  router
    router-846b84d544-ndz76  system  router         running  3.0.0.beta44  2 weeks ago  router

rack ps –all

List rack processes as well as essential system ones running on the Rack

Usage

    convox rack ps --all

Examples

    $ convox rack ps --all
    ID                       APP     SERVICE        STATUS   RELEASE       STARTED      COMMAND
    api-9749b7ccb-29zh5      system  api            running  3.0.0.beta44  2 weeks ago  api
    api-9749b7ccb-29zh5      rack    api            running  3.0.0.beta44  2 weeks ago  api
    api-9749b7ccb-cg4hr      system  api            running  3.0.0.beta44  2 weeks ago  api
    api-9749b7ccb-cg4hr      rack    api            running  3.0.0.beta44  2 weeks ago  api
    atom-578cd48bfb-6tm7g    rack    atom           running  3.0.0.beta44  2 weeks ago  atom
    atom-578cd48bfb-6tm7g    system  atom           running  3.0.0.beta44  2 weeks ago  atom
    elasticsearch-0          rack    elasticsearch  running  3.0.0.beta44  2 weeks ago
    elasticsearch-0          system  elasticsearch  running  3.0.0.beta44  2 weeks ago
    elasticsearch-1          rack    elasticsearch  running  3.0.0.beta44  2 weeks ago
    elasticsearch-1          system  elasticsearch  running  3.0.0.beta44  2 weeks ago
    fluentd-p56dk            rack    fluentd        running  3.0.0.beta44  2 weeks ago
    fluentd-p56dk            system  fluentd        running  3.0.0.beta44  2 weeks ago
    fluentd-qrttw            rack    fluentd        running  3.0.0.beta44  2 weeks ago
    fluentd-qrttw            system  fluentd        running  3.0.0.beta44  2 weeks ago
    fluentd-zsv8f            rack    fluentd        running  3.0.0.beta44  2 weeks ago
    fluentd-zsv8f            system  fluentd        running  3.0.0.beta44  2 weeks ago
    redis-77b4f65c55-nbx89   rack    redis          running  3.0.0.beta44  2 weeks ago
    redis-77b4f65c55-nbx89   system  redis          running  3.0.0.beta44  2 weeks ago
    router-846b84d544-ndz76  rack    router         running  3.0.0.beta44  2 weeks ago  router
    router-846b84d544-ndz76  system  router         running  3.0.0.beta44  2 weeks ago  router

rack runtimes

List of attachable runtime integrations

Usage

    convox rack runtimes

Examples

    $ convox rack runtimes
    ID                                    TITLE
    20e58437-fab7-4124-aa5a-2e5978f1149e  047979207916

rack runtime attach

Attach runtime integration to the rack

Usage

    convox rack runtime attach <runtime_id>

Examples

    $ convox rack runtime attach 20e58437-fab7-4124-aa5a-2e5978f11
    OK

rack uninstall

Uninstalls a Rack

Usage

    convox rack uninstall <name>

Examples

    $ convox rack uninstall my-rack
    Upgrading modules...
    Downloading github.com/convox/convox?ref=3.0.15 for system...
    ...
    Destroy complete! Resources: 35 destroyed.

rack update

Updates a Rack to a new version.

Usage

    convox rack update [version]

Examples

    $ convox rack update
    Upgrading modules...
    Downloading github.com/convox/convox?ref=3.0.15 for system...
    ...
    Apply complete! Resources: 1 added, 4 changed, 1 destroyed.

    Outputs:

    api = https://convox:password@api.dev.convox
    provider = local
    OK

rack access credential

Generates rack access credential

supported from: 3.14.1

Usage

    convox rack access --role [role] --duration-in-hours [duration]

flags:

role: Access role for the credential. Allowed roles are: read or write
duration-in-hours: TTL for the credential.

Examples

    $ convox rack access --role read --duration-in-hours 1
    RACK_URL=https://...

    $ export RACK_URL=https://...
    $ convox rack
    Name      v3-rack
    Provider  aws
    Router    router.convox
    Status    running
    Version   ...

rack access key rotation

Rotates the rack access key that is used for rack access credential. It will invalidate previous all the credential generated from convox rack access --role [role] --duration-in-hours [duration].

supported from: 3.14.1

Usage

    convox rack access key rotate

Examples

    $ convox rack access key rotate              
    OK