github.com/pachyderm/pachyderm@v1.13.4/src/client/admin/admin.proto (about)

     1  syntax = "proto3";
     2  
     3  package admin;
     4  option go_package = "github.com/pachyderm/pachyderm/src/client/admin";
     5  
     6  import "google/protobuf/empty.proto";
     7  import "gogoproto/gogo.proto";
     8  import "client/admin/v1_7/pfs/pfs.proto";
     9  import "client/admin/v1_7/pps/pps.proto";
    10  import "client/admin/v1_8/pfs/pfs.proto";
    11  import "client/admin/v1_8/pps/pps.proto";
    12  import "client/admin/v1_9/pfs/pfs.proto";
    13  import "client/admin/v1_9/pps/pps.proto";
    14  import "client/admin/v1_10/pfs/pfs.proto";
    15  import "client/admin/v1_10/pps/pps.proto";
    16  import "client/admin/v1_11/pfs/pfs.proto";
    17  import "client/admin/v1_11/pps/pps.proto";
    18  import "client/admin/v1_11/auth/auth.proto";
    19  import "client/admin/v1_11/enterprise/enterprise.proto";
    20  import "client/admin/v1_12/pfs/pfs.proto";
    21  import "client/admin/v1_12/pps/pps.proto";
    22  import "client/admin/v1_12/auth/auth.proto";
    23  import "client/admin/v1_12/enterprise/enterprise.proto";
    24  import "client/pfs/pfs.proto";
    25  import "client/pps/pps.proto";
    26  import "client/auth/auth.proto";
    27  import "client/enterprise/enterprise.proto";
    28  
    29  // CheckAuthToken is the first message in an extract on a cluster
    30  // where auth is enabled. It ensures the calling context contains 
    31  // an auth token.
    32  message CheckAuthToken {}
    33  
    34  message Op1_7 {
    35    pfs_1_7.PutObjectRequest object = 2;
    36    pfs_1_7.TagObjectRequest tag = 3;
    37    pfs_1_7.CreateRepoRequest repo = 4;
    38    pfs_1_7.BuildCommitRequest commit = 5;
    39    pfs_1_7.CreateBranchRequest branch = 6;
    40    pps_1_7.CreatePipelineRequest pipeline = 7;
    41  }
    42  
    43  message Op1_8 {
    44    pfs_1_8.PutObjectRequest object = 2;
    45    pfs_1_8.TagObjectRequest tag = 3;
    46    pfs_1_8.CreateRepoRequest repo = 4;
    47    pfs_1_8.BuildCommitRequest commit = 5;
    48    pfs_1_8.CreateBranchRequest branch = 6;
    49    pps_1_8.CreatePipelineRequest pipeline = 7;
    50  }
    51  
    52  message Op1_9 {
    53    pfs_1_9.PutObjectRequest object = 2;
    54    pfs_1_9.CreateObjectRequest create_object = 9;
    55    pfs_1_9.TagObjectRequest tag = 3;
    56    pfs_1_9.PutBlockRequest block = 10;
    57    pfs_1_9.CreateRepoRequest repo = 4;
    58    pfs_1_9.BuildCommitRequest commit = 5;
    59    pfs_1_9.CreateBranchRequest branch = 6;
    60    pps_1_9.CreatePipelineRequest pipeline = 7;
    61    pps_1_9.CreateJobRequest job = 8;
    62  }
    63  
    64  message Op1_10 {
    65    pfs_1_10.PutObjectRequest object = 2;
    66    pfs_1_10.CreateObjectRequest create_object = 9;
    67    pfs_1_10.TagObjectRequest tag = 3;
    68    pfs_1_10.PutBlockRequest block = 10;
    69    pfs_1_10.CreateRepoRequest repo = 4;
    70    pfs_1_10.BuildCommitRequest commit = 5;
    71    pfs_1_10.CreateBranchRequest branch = 6;
    72    pps_1_10.CreatePipelineRequest pipeline = 7;
    73    pps_1_10.CreateJobRequest job = 8;
    74  }
    75  
    76  
    77  message Op1_11 {
    78    pfs_1_11.PutObjectRequest object = 2;
    79    pfs_1_11.CreateObjectRequest create_object = 9;
    80    pfs_1_11.TagObjectRequest tag = 3;
    81    pfs_1_11.PutBlockRequest block = 10;
    82    pfs_1_11.CreateRepoRequest repo = 4;
    83    pfs_1_11.BuildCommitRequest commit = 5;
    84    pfs_1_11.CreateBranchRequest branch = 6;
    85    pps_1_11.CreatePipelineRequest pipeline = 7;
    86    pps_1_11.CreateJobRequest job = 8;
    87    auth_1_11.SetACLRequest set_acl = 11;
    88    auth_1_11.ModifyClusterRoleBindingRequest set_cluster_role_binding = 12;
    89    auth_1_11.SetConfigurationRequest set_auth_config = 13;
    90    auth_1_11.ActivateRequest activate_auth = 14;
    91    auth_1_11.RestoreAuthTokenRequest restore_auth_token = 15;
    92    enterprise_1_11.ActivateRequest activate_enterprise = 16;
    93    CheckAuthToken check_auth_token = 17;
    94  }
    95  
    96  message Op1_12 {
    97    pfs_1_12.PutObjectRequest object = 2;
    98    pfs_1_12.CreateObjectRequest create_object = 9;
    99    pfs_1_12.TagObjectRequest tag = 3;
   100    pfs_1_12.PutBlockRequest block = 10;
   101    pfs_1_12.CreateRepoRequest repo = 4;
   102    pfs_1_12.BuildCommitRequest commit = 5;
   103    pfs_1_12.CreateBranchRequest branch = 6;
   104    pps_1_12.CreatePipelineRequest pipeline = 7;
   105    pps_1_12.CreateJobRequest job = 8;
   106    auth_1_12.SetACLRequest set_acl = 11;
   107    auth_1_12.ModifyClusterRoleBindingRequest set_cluster_role_binding = 12;
   108    auth_1_12.SetConfigurationRequest set_auth_config = 13;
   109    auth_1_12.ActivateRequest activate_auth = 14;
   110    auth_1_12.RestoreAuthTokenRequest restore_auth_token = 15;
   111    enterprise_1_12.ActivateRequest activate_enterprise = 16;
   112    CheckAuthToken check_auth_token = 17;
   113  }
   114  
   115  message Op1_13 {
   116    pfs.PutObjectRequest object = 2;
   117    pfs.CreateObjectRequest create_object = 9;
   118    pfs.TagObjectRequest tag = 3;
   119    pfs.PutBlockRequest block = 10;
   120    pfs.CreateRepoRequest repo = 4;
   121    pfs.BuildCommitRequest commit = 5;
   122    pfs.CreateBranchRequest branch = 6;
   123    pps.CreatePipelineRequest pipeline = 7;
   124    pps.CreateJobRequest job = 8;
   125    auth.SetACLRequest set_acl = 11;
   126    auth.ModifyClusterRoleBindingRequest set_cluster_role_binding = 12;
   127    auth.SetConfigurationRequest set_auth_config = 13;
   128    auth.ActivateRequest activate_auth = 14;
   129    auth.RestoreAuthTokenRequest restore_auth_token = 15;
   130    enterprise.ActivateRequest activate_enterprise = 16;
   131    CheckAuthToken check_auth_token = 17;
   132  }
   133  
   134  // Op represents a union of types, where each type is data extracted from
   135  // a different major version of Pachyderm. The versioned Op types represent
   136  // a union of the RPC types that need to be replayed to restore the cluster.
   137  message Op {
   138    Op1_7 op1_7 = 1;
   139    Op1_8 op1_8 = 2;
   140    Op1_9 op1_9 = 3;
   141    Op1_10 op1_10 = 4;
   142    Op1_11 op1_11 = 5;
   143    Op1_12 op1_12 = 6;
   144    Op1_13 op1_13 = 7;
   145  }
   146  
   147  message ExtractRequest {
   148    // URL is an object storage URL, if it's not "" data will be extracted to
   149    // this URL rather than returned.
   150    string URL = 1;
   151    // NoObjects, if true, will cause extract to omit objects (and tags)
   152    bool no_objects = 2;
   153    // NoRepos, if true, will cause extract to omit repos, commits and branches.
   154    bool no_repos = 3;
   155    // NoPipelines, if true, will cause extract to omit pipelines.
   156    bool no_pipelines = 4;
   157    // NoEnterprise, if true, causes extract to omit the enterprise activation code 
   158    bool no_enterprise = 5;
   159    // NoAuth, if true, causes extract to omit ACLs and robot tokens
   160    bool no_auth = 6;
   161  }
   162  
   163  message ExtractPipelineRequest {
   164    pps.Pipeline pipeline = 1;
   165  }
   166  
   167  message RestoreRequest {
   168      Op op = 1;
   169      // URL is an object storage URL, if it's not "" data will be restored from
   170      // this URL.
   171      string URL = 2;
   172  }
   173  
   174  message ClusterInfo {
   175    string id = 1 [(gogoproto.customname) = "ID"];
   176    string deployment_id = 2 [(gogoproto.customname) = "DeploymentID"];
   177  }
   178  
   179  service API {
   180    rpc Extract(ExtractRequest) returns (stream Op) {}
   181    rpc ExtractPipeline(ExtractPipelineRequest) returns (Op) {}
   182    rpc Restore(stream RestoreRequest) returns (google.protobuf.Empty) {}
   183    rpc InspectCluster(google.protobuf.Empty) returns (ClusterInfo) {}
   184  }