skctl #

command-line app for running simulations with SimKube

Usage: skctl <COMMAND>

Commands:
  completions  generate shell completions for skctl
  crd          print SimKube CRDs
  delete       delete a simulation
  export       export simulation trace data
  run          run a simulation
  snapshot     take a point-in-time snapshot of a cluster (does not require sk-tracer to be running)
  validate     
  version      simkube version
  xray         explore or prepare trace data for simulation
  help         Print this message or the help of the given subcommand(s)

Options:
  -h, --help     Print help
  -V, --version  Print version

print SimKube CRDs

Usage: skctl crd

Options:
  -h, --help     Print help
  -V, --version  Print version

delete a simulation

Usage: skctl delete <NAME>

Arguments:
  <NAME>
          name of the simulation to delete

Options:
  -h, --help
          Print help (see a summary with '-h')

  -V, --version
          Print version

export simulation trace data

Usage: skctl export [OPTIONS]

Options:
  -s, --start-time <START_TIME>
          trace export start timestamp; can be a relative duration
          or absolute timestamp; durations are computed relative
          to the specified end time, _not_ the current time

          [default: -30m]

  -t, --end-time <END_TIME>
          end time; can be a relative or absolute timestamp

          [default: now]

      --excluded-namespaces <EXCLUDED_NAMESPACES>
          namespaces to exclude from the trace

          [default: cert-manager,default,kube-public,kube-node-lease,kube-system,local-path-storage,monitoring,simkube]

      --tracer-address <TRACER_ADDRESS>
          sk-tracer server address

          [default: http://localhost:7777]

  -o, --output-path <OUTPUT_PATH>
          location to save exported trace

          [default: file:///tmp/kind-node-data]

  -h, --help
          Print help (see a summary with '-h')

  -V, --version
          Print version

run a simulation

Usage: skctl run [OPTIONS] <NAME>

Arguments:
  <NAME>
          name of the simulation to run

Options:
  -D, --duration <DURATION>
          duration of the simulation

  -s, --speed <SPEED>
          Time multiplier for the simulation

          [default: 1]

  -N, --repetitions <REPETITIONS>
          number of repetitions of the simulation to run

          [default: 1]

      --driver-namespace <DRIVER_NAMESPACE>
          namespace to launch sk-driver in

          [default: simkube]

      --hooks <HOOKS>
          name of file with simulation hooks

Driver:
  -I, --driver-image <DRIVER_IMAGE>
          name of the docker image to use for sk-driver

          [default: quay.io/appliedcomputing/sk-driver:v2.0.0]

      --driver-port <DRIVER_PORT>
          admission webhook port for sk-driver

          [default: 8888]

  -f, --trace-path <TRACE_PATH>
          location of the trace file for sk-driver to read

          [default: file:///data/trace]

Metrics:
      --disable-metrics
          don't spawn Prometheus pod before running sim

      --metrics-namespace <METRICS_NAMESPACE>
          namespace to launch monitoring utilities in

          [default: monitoring]

      --metrics-service-account <METRICS_SERVICE_ACCOUNT>
          service account with monitoring permissions

          [default: prometheus-k8s]

      --metrics-pod-monitor-namespaces <METRICS_POD_MONITOR_NAMESPACES>
          comma-separated list of namespaces containing pod monitor configs

          [default: monitoring-hd]

      --metrics-pod-monitor-names <METRICS_POD_MONITOR_NAMES>
          comma-separated list of pod monitor config names
          (if empty, uses all pod monitor configs in metrics_pod_monitor_namespaces)

      --metrics-service-monitor-namespaces <METRICS_SERVICE_MONITOR_NAMESPACES>
          comma-separated list of namespaces containing service monitor configs

          [default: monitoring-hd]

      --metrics-service-monitor-names <METRICS_SERVICE_MONITOR_NAMES>
          comma-separated list of service monitor config names
          (if empty, uses all pod monitor configs in metrics_service_monitor_namespaces)

      --prometheus-shards <PROMETHEUS_SHARDS>
          number of prometheus shards to run

      --remote-write-endpoint <REMOTE_WRITE_ENDPOINT>
          address for remote write endpoint

          [default: http://prom2parquet-svc:1234/receive]

Help:
  -h, --help
          Print help (see a summary with '-h')

  -V, --version
          Print version

take a point-in-time snapshot of a cluster (does not require sk-tracer to be running)

Usage: skctl snapshot [OPTIONS] --config-file <CONFIG_FILE>

Options:
  -c, --config-file <CONFIG_FILE>
          config file specifying resources to snapshot

      --excluded-namespaces <EXCLUDED_NAMESPACES>
          namespaces to exclude from the snapshot

          [default: cert-manager,kube-system,local-path-storage,monitoring,simkube]

  -o, --output <OUTPUT>
          location to save exported trace

          [default: trace.out]

  -h, --help
          Print help (see a summary with '-h')

  -V, --version
          Print version