Skip to content

Commit

Permalink
Allow seldon inspect to output raw or json (#432)
Browse files Browse the repository at this point in the history
* Allow seldon inspect to output raw or json

* review fixes

* Review fixes

* update docs
  • Loading branch information
ukclivecox authored Sep 8, 2022
1 parent 30e13a6 commit e824324
Show file tree
Hide file tree
Showing 28 changed files with 324 additions and 115 deletions.
2 changes: 1 addition & 1 deletion docs/source/contents/cli/docs/seldon.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,4 +17,4 @@
* [seldon pipeline](seldon_pipeline.md) - manage pipelines
* [seldon server](seldon_server.md) - manage servers

###### Auto generated by spf13/cobra on 13-Aug-2022
###### Auto generated by spf13/cobra on 8-Sep-2022
2 changes: 1 addition & 1 deletion docs/source/contents/cli/docs/seldon_experiment.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,4 +31,4 @@ seldon experiment <subcomand> [flags]
* [seldon experiment status](seldon_experiment_status.md) - get status for experiment
* [seldon experiment stop](seldon_experiment_stop.md) - stop an experiment

###### Auto generated by spf13/cobra on 13-Aug-2022
###### Auto generated by spf13/cobra on 8-Sep-2022
2 changes: 1 addition & 1 deletion docs/source/contents/cli/docs/seldon_experiment_list.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,4 +28,4 @@ seldon experiment list [flags]

* [seldon experiment](seldon_experiment.md) - manage experiments

###### Auto generated by spf13/cobra on 13-Aug-2022
###### Auto generated by spf13/cobra on 8-Sep-2022
2 changes: 1 addition & 1 deletion docs/source/contents/cli/docs/seldon_experiment_start.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,4 +29,4 @@ seldon experiment start [flags]

* [seldon experiment](seldon_experiment.md) - manage experiments

###### Auto generated by spf13/cobra on 13-Aug-2022
###### Auto generated by spf13/cobra on 8-Sep-2022
2 changes: 1 addition & 1 deletion docs/source/contents/cli/docs/seldon_experiment_status.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,4 +29,4 @@ seldon experiment status <experimentName> [flags]

* [seldon experiment](seldon_experiment.md) - manage experiments

###### Auto generated by spf13/cobra on 13-Aug-2022
###### Auto generated by spf13/cobra on 8-Sep-2022
2 changes: 1 addition & 1 deletion docs/source/contents/cli/docs/seldon_experiment_stop.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,4 +28,4 @@ seldon experiment stop <experimentName> [flags]

* [seldon experiment](seldon_experiment.md) - manage experiments

###### Auto generated by spf13/cobra on 13-Aug-2022
###### Auto generated by spf13/cobra on 8-Sep-2022
2 changes: 1 addition & 1 deletion docs/source/contents/cli/docs/seldon_model.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,4 +33,4 @@ seldon model <subcomand> [flags]
* [seldon model status](seldon_model_status.md) - get status for model
* [seldon model unload](seldon_model_unload.md) - unload a model

###### Auto generated by spf13/cobra on 13-Aug-2022
###### Auto generated by spf13/cobra on 8-Sep-2022
2 changes: 1 addition & 1 deletion docs/source/contents/cli/docs/seldon_model_infer.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,4 +34,4 @@ seldon model infer <modelName> (data) [flags]

* [seldon model](seldon_model.md) - manage models

###### Auto generated by spf13/cobra on 13-Aug-2022
###### Auto generated by spf13/cobra on 8-Sep-2022
2 changes: 1 addition & 1 deletion docs/source/contents/cli/docs/seldon_model_list.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,4 +28,4 @@ seldon model list [flags]

* [seldon model](seldon_model.md) - manage models

###### Auto generated by spf13/cobra on 13-Aug-2022
###### Auto generated by spf13/cobra on 8-Sep-2022
2 changes: 1 addition & 1 deletion docs/source/contents/cli/docs/seldon_model_load.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,4 +29,4 @@ seldon model load [flags]

* [seldon model](seldon_model.md) - manage models

###### Auto generated by spf13/cobra on 13-Aug-2022
###### Auto generated by spf13/cobra on 8-Sep-2022
2 changes: 1 addition & 1 deletion docs/source/contents/cli/docs/seldon_model_metadata.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,4 +28,4 @@ seldon model metadata <modelName> [flags]

* [seldon model](seldon_model.md) - manage models

###### Auto generated by spf13/cobra on 13-Aug-2022
###### Auto generated by spf13/cobra on 8-Sep-2022
2 changes: 1 addition & 1 deletion docs/source/contents/cli/docs/seldon_model_status.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,4 +29,4 @@ seldon model status <modelName> [flags]

* [seldon model](seldon_model.md) - manage models

###### Auto generated by spf13/cobra on 13-Aug-2022
###### Auto generated by spf13/cobra on 8-Sep-2022
2 changes: 1 addition & 1 deletion docs/source/contents/cli/docs/seldon_model_unload.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,4 +28,4 @@ seldon model unload <modelName> [flags]

* [seldon model](seldon_model.md) - manage models

###### Auto generated by spf13/cobra on 13-Aug-2022
###### Auto generated by spf13/cobra on 8-Sep-2022
2 changes: 1 addition & 1 deletion docs/source/contents/cli/docs/seldon_pipeline.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,4 +33,4 @@ seldon pipeline <subcomand> [flags]
* [seldon pipeline status](seldon_pipeline_status.md) - status of a pipeline
* [seldon pipeline unload](seldon_pipeline_unload.md) - unload a pipeline

###### Auto generated by spf13/cobra on 13-Aug-2022
###### Auto generated by spf13/cobra on 8-Sep-2022
2 changes: 1 addition & 1 deletion docs/source/contents/cli/docs/seldon_pipeline_infer.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,4 +34,4 @@ seldon pipeline infer <pipelineName> (data) [flags]

* [seldon pipeline](seldon_pipeline.md) - manage pipelines

###### Auto generated by spf13/cobra on 13-Aug-2022
###### Auto generated by spf13/cobra on 8-Sep-2022
4 changes: 3 additions & 1 deletion docs/source/contents/cli/docs/seldon_pipeline_inspect.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,11 +13,13 @@ seldon pipeline inspect <expression> [flags]
### Options

```
--format string inspect output format: raw or json. Default raw (default "raw")
-h, --help help for inspect
--kafka-broker string kafka broker (default "0.0.0.0:9092")
--offset int message offset to start reading from, i.e. default 1 is the last message only (default 1)
--request-id string request id to show, if not specified will be all messages in offset range
--scheduler-host string seldon scheduler host (default "0.0.0.0:9004")
--verbose verbose output
```

### Options inherited from parent commands
Expand All @@ -31,4 +33,4 @@ seldon pipeline inspect <expression> [flags]

* [seldon pipeline](seldon_pipeline.md) - manage pipelines

###### Auto generated by spf13/cobra on 13-Aug-2022
###### Auto generated by spf13/cobra on 8-Sep-2022
2 changes: 1 addition & 1 deletion docs/source/contents/cli/docs/seldon_pipeline_list.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,4 +28,4 @@ seldon pipeline list [flags]

* [seldon pipeline](seldon_pipeline.md) - manage pipelines

###### Auto generated by spf13/cobra on 13-Aug-2022
###### Auto generated by spf13/cobra on 8-Sep-2022
2 changes: 1 addition & 1 deletion docs/source/contents/cli/docs/seldon_pipeline_load.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,4 +29,4 @@ seldon pipeline load [flags]

* [seldon pipeline](seldon_pipeline.md) - manage pipelines

###### Auto generated by spf13/cobra on 13-Aug-2022
###### Auto generated by spf13/cobra on 8-Sep-2022
2 changes: 1 addition & 1 deletion docs/source/contents/cli/docs/seldon_pipeline_status.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,4 +29,4 @@ seldon pipeline status <pipelineName> [flags]

* [seldon pipeline](seldon_pipeline.md) - manage pipelines

###### Auto generated by spf13/cobra on 13-Aug-2022
###### Auto generated by spf13/cobra on 8-Sep-2022
2 changes: 1 addition & 1 deletion docs/source/contents/cli/docs/seldon_pipeline_unload.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,4 +28,4 @@ seldon pipeline unload <pipelineName> [flags]

* [seldon pipeline](seldon_pipeline.md) - manage pipelines

###### Auto generated by spf13/cobra on 13-Aug-2022
###### Auto generated by spf13/cobra on 8-Sep-2022
2 changes: 1 addition & 1 deletion docs/source/contents/cli/docs/seldon_server.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,4 +29,4 @@ seldon server <subcomand> [flags]
* [seldon server list](seldon_server_list.md) - get list of servers
* [seldon server status](seldon_server_status.md) - get status for server

###### Auto generated by spf13/cobra on 13-Aug-2022
###### Auto generated by spf13/cobra on 8-Sep-2022
2 changes: 1 addition & 1 deletion docs/source/contents/cli/docs/seldon_server_list.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,4 +28,4 @@ seldon server list [flags]

* [seldon server](seldon_server.md) - manage servers

###### Auto generated by spf13/cobra on 13-Aug-2022
###### Auto generated by spf13/cobra on 8-Sep-2022
2 changes: 1 addition & 1 deletion docs/source/contents/cli/docs/seldon_server_status.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,4 +29,4 @@ seldon server status [flags]

* [seldon server](seldon_server.md) - manage servers

###### Auto generated by spf13/cobra on 13-Aug-2022
###### Auto generated by spf13/cobra on 8-Sep-2022
28 changes: 21 additions & 7 deletions operator/cmd/seldon/cli/pipeline_inspect.go
Original file line number Diff line number Diff line change
@@ -1,15 +1,19 @@
package cli

import (
"fmt"

"k8s.io/utils/env"

"github.com/seldonio/seldon-core/operatorv2/pkg/cli"
"github.com/spf13/cobra"
)

const (
OffsetFlag = "offset"
RequestIdFlag = "request-id"
offsetFlag = "offset"
requestIdFlag = "request-id"
outputFormatFlag = "format"
verboseFlag = "verbose"
)

func createPipelineInspect() *cobra.Command {
Expand All @@ -27,11 +31,19 @@ func createPipelineInspect() *cobra.Command {
if err != nil {
return err
}
offset, err := cmd.Flags().GetInt64(OffsetFlag)
offset, err := cmd.Flags().GetInt64(offsetFlag)
if err != nil {
return err
}
requestId, err := cmd.Flags().GetString(requestIdFlag)
if err != nil {
return err
}
format, err := cmd.Flags().GetString(outputFormatFlag)
if err != nil {
return err
}
requestId, err := cmd.Flags().GetString(RequestIdFlag)
verbose, err := cmd.Flags().GetBool(verboseFlag)
if err != nil {
return err
}
Expand All @@ -40,13 +52,15 @@ func createPipelineInspect() *cobra.Command {
if err != nil {
return err
}
err = kc.InspectStep(string(data), offset, requestId)
err = kc.InspectStep(string(data), offset, requestId, format, verbose)
return err
},
}
cmdPipelineInspect.Flags().String(kafkaBrokerFlag, env.GetString(EnvKafka, DefaultKafkaHost), "kafka broker")
cmdPipelineInspect.Flags().Int64(OffsetFlag, 1, "message offset to start reading from, i.e. default 1 is the last message only")
cmdPipelineInspect.Flags().String(RequestIdFlag, "", "request id to show, if not specified will be all messages in offset range")
cmdPipelineInspect.Flags().Int64(offsetFlag, 1, "message offset to start reading from, i.e. default 1 is the last message only")
cmdPipelineInspect.Flags().String(requestIdFlag, "", "request id to show, if not specified will be all messages in offset range")
cmdPipelineInspect.Flags().String(schedulerHostFlag, env.GetString(EnvScheduler, DefaultScheduleHost), "seldon scheduler host")
cmdPipelineInspect.Flags().String(outputFormatFlag, cli.InspectFormatRaw, fmt.Sprintf("inspect output format: raw or json. Default %s", cli.InspectFormatRaw))
cmdPipelineInspect.Flags().Bool(verboseFlag, false, "verbose output")
return cmdPipelineInspect
}
7 changes: 7 additions & 0 deletions operator/pkg/cli/constants.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
package cli

// CLI constants
const (
InspectFormatRaw = "raw"
InspectFormatJson = "json"
)
Loading

0 comments on commit e824324

Please sign in to comment.