This is the multi-page printable view of this section. Click here to print.

Return to the regular view of this page.

deployer

Manage target services

skyramp deployer

skyramp deployer [flags]

Options inherited from parent commands

      --kube-insecure         enable insecure mode for interactions with Kubernetes clusters
  -p, --project-path string   path to Skyramp project folder (default ".")
  -v, --verbose count         verbose (-v or -vv)

SEE ALSO

  • skyramp - Command line tool to interact with Skyramp
  • clean - Remove all Kubernetes resources deployed by Skyramp
  • coverage - Configures or retrieves coverage data
  • down - Tear down target services
  • generate - Generates configurations from an existing deployment
  • status - Show details for deployed targets
  • up - Bring up target services

1 - clean

Remove all Kubernetes resources deployed by Skyramp

skyramp deployer clean

Remove all Kubernetes resources deployed by Skyramp from a cluster. Note that this will not clean up the cluster(s) and infrastructure.

skyramp deployer clean [flags]

Options

  -c, --cluster string   cluster context for Skyramp

Options inherited from parent commands

      --kube-insecure         enable insecure mode for interactions with Kubernetes clusters
  -p, --project-path string   path to Skyramp project folder (default ".")
  -v, --verbose count         verbose (-v or -vv)

SEE ALSO

2 - coverage

Configures or retrieves coverage data

skyramp deployer coverage

skyramp deployer coverage [flags]

Options

  -n, --namespace string   Kubernetes namespace

Options inherited from parent commands

      --kube-insecure         enable insecure mode for interactions with Kubernetes clusters
  -p, --project-path string   path to Skyramp project folder (default ".")
  -v, --verbose count         verbose (-v or -vv)

SEE ALSO

  • deployer - Manage target services
  • collect - Retrieves coverage data
  • restart - Resets the collected coverage data

2.1 - collect

Retrieves coverage data

skyramp deployer coverage collect

skyramp deployer coverage collect [flags]

Options

      --api-schema strings         schema file(s) to use for the coverage data
      --code-coverage-out string   output directory for the code coverage data (default "/tmp/cover")
      --protocol string            protocol to use for the schema files (one of [rest]) (default "rest")

Options inherited from parent commands

      --kube-insecure         enable insecure mode for interactions with Kubernetes clusters
  -p, --project-path string   path to Skyramp project folder (default ".")
  -v, --verbose count         verbose (-v or -vv)

SEE ALSO

  • coverage - Configures or retrieves coverage data

2.2 - restart

Resets the collected coverage data

skyramp deployer coverage restart

skyramp deployer coverage restart <target-name> [flags]

Options inherited from parent commands

      --kube-insecure         enable insecure mode for interactions with Kubernetes clusters
  -p, --project-path string   path to Skyramp project folder (default ".")
  -v, --verbose count         verbose (-v or -vv)

SEE ALSO

  • coverage - Configures or retrieves coverage data

3 - down

Tear down target services

skyramp deployer down

skyramp deployer down <target name> [flags]

Options

  -c, --cluster string     cluster context for Skyramp
  -f, --force              force delete the target
  -n, --namespace string   Kubernetes namespace

Options inherited from parent commands

      --kube-insecure         enable insecure mode for interactions with Kubernetes clusters
  -p, --project-path string   path to Skyramp project folder (default ".")
  -v, --verbose count         verbose (-v or -vv)

SEE ALSO

4 - generate

Generates configurations from an existing deployment

skyramp deployer generate

skyramp deployer generate [flags]

Options

      --api-coverage      generate and pull API coverage data
      --code-coverage     generate and pull code coverage data
      --protocol string   protocol to use for the deployer configuration (one of [rest]) (default "rest")

Options inherited from parent commands

      --kube-insecure         enable insecure mode for interactions with Kubernetes clusters
  -p, --project-path string   path to Skyramp project folder (default ".")
  -v, --verbose count         verbose (-v or -vv)

SEE ALSO

  • deployer - Manage target services
  • kubernetes - Generates configurations from an existing deployment in Kubernetes

4.1 - kubernetes

Generates configurations from an existing deployment in Kubernetes

skyramp deployer generate kubernetes

skyramp deployer generate kubernetes [flags]

Options

      --kubeconfig string   path of the kubeconfig where 
      --namespace string    namespace where the application is deployed

Options inherited from parent commands

      --api-coverage          generate and pull API coverage data
      --code-coverage         generate and pull code coverage data
      --kube-insecure         enable insecure mode for interactions with Kubernetes clusters
  -p, --project-path string   path to Skyramp project folder (default ".")
      --protocol string       protocol to use for the deployer configuration (one of [rest]) (default "rest")
  -v, --verbose count         verbose (-v or -vv)

SEE ALSO

  • generate - Generates configurations from an existing deployment

5 - status

Show details for deployed targets

skyramp deployer status

skyramp deployer status [flags]

Options

  -c, --cluster string   cluster context for Skyramp

Options inherited from parent commands

      --kube-insecure         enable insecure mode for interactions with Kubernetes clusters
  -p, --project-path string   path to Skyramp project folder (default ".")
  -v, --verbose count         verbose (-v or -vv)

SEE ALSO

6 - up

Bring up target services

skyramp deployer up

skyramp deployer up <target name> [flags]

Options

  -c, --cluster string        cluster context for Skyramp
      --local-images          load local container images
  -n, --namespace string      Kubernetes namespace
      --skip-deploy-worker    
      --worker-image string   worker image URL

Options inherited from parent commands

      --kube-insecure         enable insecure mode for interactions with Kubernetes clusters
  -p, --project-path string   path to Skyramp project folder (default ".")
  -v, --verbose count         verbose (-v or -vv)

SEE ALSO