github.com/GoogleContainerTools/skaffold/v2@v2.13.2/docs-v1/content/en/docs/references/api/grpc.md (about)

     1  ---
     2  title: "gRPC API"
     3  linkTitle: "gRPC API"
     4  weight: 30
     5  ---
     6  <!--
     7  ******
     8  WARNING!!!
     9  
    10  The file docs-v1/content/en/docs/references/api/grpc.md is generated based on proto/markdown.tmpl,
    11  and generated with ./hack/generate_proto.sh!
    12  Please edit the template file and not the markdown one directly!
    13  
    14  ******
    15  -->
    16  This is a generated reference for the [Skaffold API]({{<relref "/docs/design/api">}}) gRPC layer.
    17  
    18  We also generate the [reference doc for the HTTP layer]({{<relref "/docs/references/api/swagger">}}).
    19  
    20  
    21  
    22  <a name="v1/skaffold.proto"></a>
    23  
    24  ## v1/skaffold.proto
    25  
    26  You can find the source for v1/skaffold.proto [on Github](https://github.com/GoogleContainerTools/skaffold/blob/main/proto/v1/skaffold.proto).
    27  
    28  
    29  
    30  ### Services
    31  
    32  <a name="proto.SkaffoldService"></a>
    33  
    34  #### SkaffoldService
    35  Describes all the methods for the Skaffold API
    36  
    37  | Method Name | Request Type | Response Type | Description |
    38  | ----------- | ------------ | ------------- | ------------|
    39  | GetState | [.google.protobuf.Empty](#google.protobuf.Empty) | [State](#proto.State) | Returns the state of the current Skaffold execution |
    40  | EventLog | [LogEntry](#proto.LogEntry) stream | [LogEntry](#proto.LogEntry) stream | DEPRECATED. Events should be used instead. TODO remove (https://github.com/GoogleContainerTools/skaffold/issues/3168) |
    41  | Events | [.google.protobuf.Empty](#google.protobuf.Empty) | [LogEntry](#proto.LogEntry) stream | Returns all the events of the current Skaffold execution from the start |
    42  | Execute | [UserIntentRequest](#proto.UserIntentRequest) | [.google.protobuf.Empty](#google.protobuf.Empty) | Allows for a single execution of some or all of the phases (build, sync, deploy) in case autoBuild, autoDeploy or autoSync are disabled. |
    43  | AutoBuild | [TriggerRequest](#proto.TriggerRequest) | [.google.protobuf.Empty](#google.protobuf.Empty) | Allows for enabling or disabling automatic build trigger |
    44  | AutoSync | [TriggerRequest](#proto.TriggerRequest) | [.google.protobuf.Empty](#google.protobuf.Empty) | Allows for enabling or disabling automatic sync trigger |
    45  | AutoDeploy | [TriggerRequest](#proto.TriggerRequest) | [.google.protobuf.Empty](#google.protobuf.Empty) | Allows for enabling or disabling automatic deploy trigger |
    46  | Handle | [Event](#proto.Event) | [.google.protobuf.Empty](#google.protobuf.Empty) | EXPERIMENTAL. It allows for custom events to be implemented in custom builders for example. |
    47  
    48   <!-- end services -->
    49  
    50  
    51  ### Data types
    52  
    53  
    54  
    55  <a name="proto.ActionableErr"></a>
    56  #### ActionableErr
    57  `ActionableErr` defines an error that occurred along with an optional list of suggestions
    58  
    59  
    60  | Field | Type | Label | Description |
    61  | ----- | ---- | ----- | ----------- |
    62  | errCode | [enums.StatusCode](#proto.enums.StatusCode) |  | error code representing the error |
    63  | message | [string](#string) |  | message describing the error. |
    64  | suggestions | [Suggestion](#proto.Suggestion) | repeated | list of suggestions |
    65  
    66  
    67  
    68  
    69  
    70  
    71  
    72  <a name="proto.BuildEvent"></a>
    73  #### BuildEvent
    74  `BuildEvent` describes the build status per artifact, and will be emitted by Skaffold anytime a build starts or finishes, successfully or not.
    75  If the build fails, an error will be attached to the event.
    76  
    77  
    78  | Field | Type | Label | Description |
    79  | ----- | ---- | ----- | ----------- |
    80  | artifact | [string](#string) |  | artifact name |
    81  | status | [string](#string) |  | artifact build status oneof: InProgress, Completed, Failed |
    82  | err | [string](#string) |  | Deprecated. Use actionableErr.message. error when build status is Failed. |
    83  | errCode | [enums.StatusCode](#proto.enums.StatusCode) |  | Deprecated. Use actionableErr.errCode. status code representing success or failure |
    84  | actionableErr | [ActionableErr](#proto.ActionableErr) |  | actionable error message |
    85  | hostPlatform | [string](#string) |  | architecture of the host machine. For example `linux/amd64` |
    86  | targetPlatforms | [string](#string) |  | comma-delimited list of build target architectures. For example `linux/amd64,linux/arm64` |
    87  
    88  
    89  
    90  
    91  
    92  
    93  
    94  <a name="proto.BuildMetadata"></a>
    95  #### BuildMetadata
    96  
    97  
    98  
    99  | Field | Type | Label | Description |
   100  | ----- | ---- | ----- | ----------- |
   101  | numberOfArtifacts | [int32](#int32) |  |  |
   102  | builders | [BuildMetadata.ImageBuilder](#proto.BuildMetadata.ImageBuilder) | repeated |  |
   103  | type | [enums.BuildType](#proto.enums.BuildType) |  |  |
   104  | additional | [BuildMetadata.AdditionalEntry](#proto.BuildMetadata.AdditionalEntry) | repeated | Additional key value pairs to describe the deploy pipeline |
   105  
   106  
   107  
   108  
   109  
   110  
   111  
   112  <a name="proto.BuildMetadata.AdditionalEntry"></a>
   113  #### BuildMetadata.AdditionalEntry
   114  
   115  
   116  
   117  | Field | Type | Label | Description |
   118  | ----- | ---- | ----- | ----------- |
   119  | key | [string](#string) |  |  |
   120  | value | [string](#string) |  |  |
   121  
   122  
   123  
   124  
   125  
   126  
   127  
   128  <a name="proto.BuildMetadata.ImageBuilder"></a>
   129  #### BuildMetadata.ImageBuilder
   130  
   131  
   132  
   133  | Field | Type | Label | Description |
   134  | ----- | ---- | ----- | ----------- |
   135  | type | [enums.BuilderType](#proto.enums.BuilderType) |  |  |
   136  | count | [int32](#int32) |  |  |
   137  
   138  
   139  
   140  
   141  
   142  
   143  
   144  <a name="proto.BuildState"></a>
   145  #### BuildState
   146  `BuildState` maps Skaffold artifacts to their current build states
   147  
   148  
   149  | Field | Type | Label | Description |
   150  | ----- | ---- | ----- | ----------- |
   151  | artifacts | [BuildState.ArtifactsEntry](#proto.BuildState.ArtifactsEntry) | repeated | A map of `artifact name -> build-state`. Artifact name is defined in the `skaffold.yaml`. The `build-state` can be: <br> - `"Not started"`: not yet started <br> - `"In progress"`: build started <br> - `"Complete"`: build succeeded <br> - `"Failed"`: build failed |
   152  | autoTrigger | [bool](#bool) |  |  |
   153  | statusCode | [enums.StatusCode](#proto.enums.StatusCode) |  |  |
   154  
   155  
   156  
   157  
   158  
   159  
   160  
   161  <a name="proto.BuildState.ArtifactsEntry"></a>
   162  #### BuildState.ArtifactsEntry
   163  
   164  
   165  
   166  | Field | Type | Label | Description |
   167  | ----- | ---- | ----- | ----------- |
   168  | key | [string](#string) |  |  |
   169  | value | [string](#string) |  |  |
   170  
   171  
   172  
   173  
   174  
   175  
   176  
   177  <a name="proto.DebuggingContainerEvent"></a>
   178  #### DebuggingContainerEvent
   179  DebuggingContainerEvent is raised when a debugging container is started or terminated
   180  
   181  
   182  | Field | Type | Label | Description |
   183  | ----- | ---- | ----- | ----------- |
   184  | status | [string](#string) |  | the container status oneof: Started, Terminated |
   185  | podName | [string](#string) |  | the pod name with the debugging container |
   186  | containerName | [string](#string) |  | the name of the container configured for debugging |
   187  | namespace | [string](#string) |  | the namespace of the debugging container |
   188  | artifact | [string](#string) |  | the corresponding artifact's image name |
   189  | runtime | [string](#string) |  | the detected language runtime |
   190  | workingDir | [string](#string) |  | the working directory in the container image |
   191  | debugPorts | [DebuggingContainerEvent.DebugPortsEntry](#proto.DebuggingContainerEvent.DebugPortsEntry) | repeated | the exposed debugging-related ports |
   192  
   193  
   194  
   195  
   196  
   197  
   198  
   199  <a name="proto.DebuggingContainerEvent.DebugPortsEntry"></a>
   200  #### DebuggingContainerEvent.DebugPortsEntry
   201  
   202  
   203  
   204  | Field | Type | Label | Description |
   205  | ----- | ---- | ----- | ----------- |
   206  | key | [string](#string) |  |  |
   207  | value | [uint32](#uint32) |  |  |
   208  
   209  
   210  
   211  
   212  
   213  
   214  
   215  <a name="proto.DeployEvent"></a>
   216  #### DeployEvent
   217  `DeployEvent` represents the status of a deployment, and is emitted by Skaffold
   218  anytime a deployment starts or completes, successfully or not.
   219  
   220  
   221  | Field | Type | Label | Description |
   222  | ----- | ---- | ----- | ----------- |
   223  | status | [string](#string) |  | deployment status oneof: InProgress, Completed, Failed |
   224  | err | [string](#string) |  | Deprecated. Use actionableErr.message. error when status is Failed |
   225  | errCode | [enums.StatusCode](#proto.enums.StatusCode) |  | Deprecated. Use actionableErr.errCode. status code representing success or failure |
   226  | actionableErr | [ActionableErr](#proto.ActionableErr) |  | actionable error message |
   227  
   228  
   229  
   230  
   231  
   232  
   233  
   234  <a name="proto.DeployMetadata"></a>
   235  #### DeployMetadata
   236  
   237  
   238  
   239  | Field | Type | Label | Description |
   240  | ----- | ---- | ----- | ----------- |
   241  | deployers | [DeployMetadata.Deployer](#proto.DeployMetadata.Deployer) | repeated |  |
   242  | cluster | [enums.ClusterType](#proto.enums.ClusterType) |  |  |
   243  
   244  
   245  
   246  
   247  
   248  
   249  
   250  <a name="proto.DeployMetadata.Deployer"></a>
   251  #### DeployMetadata.Deployer
   252  
   253  
   254  
   255  | Field | Type | Label | Description |
   256  | ----- | ---- | ----- | ----------- |
   257  | type | [enums.DeployerType](#proto.enums.DeployerType) |  |  |
   258  | count | [int32](#int32) |  |  |
   259  
   260  
   261  
   262  
   263  
   264  
   265  
   266  <a name="proto.DeployState"></a>
   267  #### DeployState
   268  `DeployState` describes the status of the current deploy
   269  
   270  
   271  | Field | Type | Label | Description |
   272  | ----- | ---- | ----- | ----------- |
   273  | status | [string](#string) |  |  |
   274  | autoTrigger | [bool](#bool) |  |  |
   275  | statusCode | [enums.StatusCode](#proto.enums.StatusCode) |  |  |
   276  
   277  
   278  
   279  
   280  
   281  
   282  
   283  <a name="proto.DevLoopEvent"></a>
   284  #### DevLoopEvent
   285  `DevLoopEvent` marks the start and end of a dev loop.
   286  
   287  
   288  | Field | Type | Label | Description |
   289  | ----- | ---- | ----- | ----------- |
   290  | iteration | [int32](#int32) |  | dev loop iteration. 0 represents initialization loop. |
   291  | status | [string](#string) |  | dev loop status oneof: In Progress, Completed, Failed |
   292  | err | [ActionableErr](#proto.ActionableErr) |  | actionable error message |
   293  
   294  
   295  
   296  
   297  
   298  
   299  
   300  <a name="proto.Event"></a>
   301  #### Event
   302  `Event` describes an event in the Skaffold process.
   303  It is one of MetaEvent, BuildEvent, TestEvent, DeployEvent, PortEvent, StatusCheckEvent, ResourceStatusCheckEvent, FileSyncEvent, or DebuggingContainerEvent.
   304  
   305  
   306  | Field | Type | Label | Description |
   307  | ----- | ---- | ----- | ----------- |
   308  | metaEvent | [MetaEvent](#proto.MetaEvent) |  | contains general information regarding Skaffold like version info |
   309  | buildEvent | [BuildEvent](#proto.BuildEvent) |  | describes if the build status per artifact. Status could be one of "InProgress", "Completed" or "Failed". |
   310  | deployEvent | [DeployEvent](#proto.DeployEvent) |  | describes if the deployment has started, is in progress or is complete. |
   311  | portEvent | [PortEvent](#proto.PortEvent) |  | describes each port forwarding event. |
   312  | statusCheckEvent | [StatusCheckEvent](#proto.StatusCheckEvent) |  | describes if the Status check has started, is in progress, has succeeded or failed. |
   313  | resourceStatusCheckEvent | [ResourceStatusCheckEvent](#proto.ResourceStatusCheckEvent) |  | indicates progress for each kubernetes deployment. |
   314  | fileSyncEvent | [FileSyncEvent](#proto.FileSyncEvent) |  | describes the sync status. |
   315  | debuggingContainerEvent | [DebuggingContainerEvent](#proto.DebuggingContainerEvent) |  | describes the appearance or disappearance of a debugging container |
   316  | devLoopEvent | [DevLoopEvent](#proto.DevLoopEvent) |  | describes a start and end of a dev loop. |
   317  | terminationEvent | [TerminationEvent](#proto.TerminationEvent) |  | describes a skaffold termination event |
   318  | TestEvent | [TestEvent](#proto.TestEvent) |  | describes if the test has started, is in progress or is complete. |
   319  
   320  
   321  
   322  
   323  
   324  
   325  
   326  <a name="proto.FileSyncEvent"></a>
   327  #### FileSyncEvent
   328  FileSyncEvent describes the sync status.
   329  
   330  
   331  | Field | Type | Label | Description |
   332  | ----- | ---- | ----- | ----------- |
   333  | fileCount | [int32](#int32) |  | number of files synced |
   334  | image | [string](#string) |  | the container image to which files are sycned. |
   335  | status | [string](#string) |  | status of file sync. one of: Not Started, In progress, Succeeded, Failed. |
   336  | err | [string](#string) |  | Deprecated. Use actionableErr.message. error in case of status failed. |
   337  | errCode | [enums.StatusCode](#proto.enums.StatusCode) |  | Deprecated. Use actionableErr.errCode. status code representing success or failure |
   338  | actionableErr | [ActionableErr](#proto.ActionableErr) |  | actionable error message |
   339  
   340  
   341  
   342  
   343  
   344  
   345  
   346  <a name="proto.FileSyncState"></a>
   347  #### FileSyncState
   348  `FileSyncState` contains the status of the current file sync
   349  
   350  
   351  | Field | Type | Label | Description |
   352  | ----- | ---- | ----- | ----------- |
   353  | status | [string](#string) |  |  |
   354  | autoTrigger | [bool](#bool) |  |  |
   355  
   356  
   357  
   358  
   359  
   360  
   361  
   362  <a name="proto.IntOrString"></a>
   363  #### IntOrString
   364  IntOrString is a type that can hold an int32 or a string.
   365  
   366  
   367  | Field | Type | Label | Description |
   368  | ----- | ---- | ----- | ----------- |
   369  | type | [int32](#int32) |  | type of stored value |
   370  | intVal | [int32](#int32) |  | int value |
   371  | strVal | [string](#string) |  | string value |
   372  
   373  
   374  
   375  
   376  
   377  
   378  
   379  <a name="proto.Intent"></a>
   380  #### Intent
   381  Intent represents user intents for a given phase.
   382  
   383  
   384  | Field | Type | Label | Description |
   385  | ----- | ---- | ----- | ----------- |
   386  | build | [bool](#bool) |  | in case skaffold dev is ran with autoBuild=false, a build intent enables building once |
   387  | sync | [bool](#bool) |  | in case skaffold dev is ran with autoSync=false, a sync intent enables file sync once |
   388  | deploy | [bool](#bool) |  | in case skaffold dev is ran with autoDeploy=false, a deploy intent enables deploys once |
   389  | devloop | [bool](#bool) |  | in case skaffold dev is ran with autoDeploy=false, autoSync=false and autoBuild=false a devloop intent enables the entire dev loop once |
   390  
   391  
   392  
   393  
   394  
   395  
   396  
   397  <a name="proto.LogEntry"></a>
   398  #### LogEntry
   399  LogEntry describes an event and a string description of the event.
   400  
   401  
   402  | Field | Type | Label | Description |
   403  | ----- | ---- | ----- | ----------- |
   404  | timestamp | [google.protobuf.Timestamp](#google.protobuf.Timestamp) |  | timestamp of the event. |
   405  | event | [Event](#proto.Event) |  | the actual event that is one of |
   406  | entry | [string](#string) |  | description of the event. |
   407  
   408  
   409  
   410  
   411  
   412  
   413  
   414  <a name="proto.MetaEvent"></a>
   415  #### MetaEvent
   416  `MetaEvent` provides general information regarding Skaffold
   417  
   418  
   419  | Field | Type | Label | Description |
   420  | ----- | ---- | ----- | ----------- |
   421  | entry | [string](#string) |  | entry, for example: `"Starting Skaffold: {Version:v0.39.0-16-g5bb7c9e0 ConfigVersion:skaffold/v1 GitVersion: GitCommit:5bb7c9e078e4d522a5ffc42a2f1274fd17d75902 GitTreeState:dirty BuildDate01:29Z GoVersion:go1.13rc1 Compiler:gc Platform:linux/amd64}"` |
   422  | metadata | [Metadata](#proto.Metadata) |  | Metadata describing skaffold pipeline |
   423  
   424  
   425  
   426  
   427  
   428  
   429  
   430  <a name="proto.Metadata"></a>
   431  #### Metadata
   432  
   433  
   434  
   435  | Field | Type | Label | Description |
   436  | ----- | ---- | ----- | ----------- |
   437  | build | [BuildMetadata](#proto.BuildMetadata) |  |  |
   438  | deploy | [DeployMetadata](#proto.DeployMetadata) |  |  |
   439  | test | [TestMetadata](#proto.TestMetadata) |  |  |
   440  | additional | [Metadata.AdditionalEntry](#proto.Metadata.AdditionalEntry) | repeated | Additional key value pairs to describe the build pipeline |
   441  
   442  
   443  
   444  
   445  
   446  
   447  
   448  <a name="proto.Metadata.AdditionalEntry"></a>
   449  #### Metadata.AdditionalEntry
   450  
   451  
   452  
   453  | Field | Type | Label | Description |
   454  | ----- | ---- | ----- | ----------- |
   455  | key | [string](#string) |  |  |
   456  | value | [string](#string) |  |  |
   457  
   458  
   459  
   460  
   461  
   462  
   463  
   464  <a name="proto.PortEvent"></a>
   465  #### PortEvent
   466  PortEvent Event describes each port forwarding event.
   467  
   468  
   469  | Field | Type | Label | Description |
   470  | ----- | ---- | ----- | ----------- |
   471  | localPort | [int32](#int32) |  | local port for forwarded resource |
   472  | remotePort | [int32](#int32) |  | Deprecated. Uses targetPort.intVal. |
   473  | podName | [string](#string) |  | pod name if port forwarded resourceType is Pod |
   474  | containerName | [string](#string) |  | container name if specified in the kubernetes spec |
   475  | namespace | [string](#string) |  | the namespace of the resource to port forward. |
   476  | portName | [string](#string) |  |  |
   477  | resourceType | [string](#string) |  | resource type e.g. "pod", "service". |
   478  | resourceName | [string](#string) |  | name of the resource to forward. |
   479  | address | [string](#string) |  | address on which to bind |
   480  | targetPort | [IntOrString](#proto.IntOrString) |  | target port is the resource port that will be forwarded. |
   481  
   482  
   483  
   484  
   485  
   486  
   487  
   488  <a name="proto.Request"></a>
   489  #### Request
   490  
   491  
   492  
   493  | Field | Type | Label | Description |
   494  | ----- | ---- | ----- | ----------- |
   495  | name | [string](#string) |  |  |
   496  
   497  
   498  
   499  
   500  
   501  
   502  
   503  <a name="proto.ResourceStatusCheckEvent"></a>
   504  #### ResourceStatusCheckEvent
   505  A Resource StatusCheck Event, indicates progress for each kubernetes deployment.
   506  For every resource, there will be exactly one event with `status` *Succeeded* or *Failed* event.
   507  There can be multiple events with `status` *Pending*.
   508  Skaffold polls for resource status every 0.5 second. If the resource status changes, an event with `status` “Pending”, “Complete” and “Failed”
   509  will be sent with the new status.
   510  
   511  
   512  | Field | Type | Label | Description |
   513  | ----- | ---- | ----- | ----------- |
   514  | resource | [string](#string) |  |  |
   515  | status | [string](#string) |  |  |
   516  | message | [string](#string) |  |  |
   517  | err | [string](#string) |  | Deprecated. Use actionableErr.message. |
   518  | statusCode | [enums.StatusCode](#proto.enums.StatusCode) |  |  |
   519  | actionableErr | [ActionableErr](#proto.ActionableErr) |  | actionable error message |
   520  
   521  
   522  
   523  
   524  
   525  
   526  
   527  <a name="proto.Response"></a>
   528  #### Response
   529  
   530  
   531  
   532  | Field | Type | Label | Description |
   533  | ----- | ---- | ----- | ----------- |
   534  | msg | [string](#string) |  |  |
   535  
   536  
   537  
   538  
   539  
   540  
   541  
   542  <a name="proto.State"></a>
   543  #### State
   544  `State` represents the current state of the Skaffold components
   545  
   546  
   547  | Field | Type | Label | Description |
   548  | ----- | ---- | ----- | ----------- |
   549  | buildState | [BuildState](#proto.BuildState) |  |  |
   550  | deployState | [DeployState](#proto.DeployState) |  |  |
   551  | forwardedPorts | [State.ForwardedPortsEntry](#proto.State.ForwardedPortsEntry) | repeated |  |
   552  | statusCheckState | [StatusCheckState](#proto.StatusCheckState) |  |  |
   553  | fileSyncState | [FileSyncState](#proto.FileSyncState) |  |  |
   554  | debuggingContainers | [DebuggingContainerEvent](#proto.DebuggingContainerEvent) | repeated |  |
   555  | metadata | [Metadata](#proto.Metadata) |  |  |
   556  | testState | [TestState](#proto.TestState) |  |  |
   557  
   558  
   559  
   560  
   561  
   562  
   563  
   564  <a name="proto.State.ForwardedPortsEntry"></a>
   565  #### State.ForwardedPortsEntry
   566  
   567  
   568  
   569  | Field | Type | Label | Description |
   570  | ----- | ---- | ----- | ----------- |
   571  | key | [int32](#int32) |  |  |
   572  | value | [PortEvent](#proto.PortEvent) |  |  |
   573  
   574  
   575  
   576  
   577  
   578  
   579  
   580  <a name="proto.StateResponse"></a>
   581  #### StateResponse
   582  
   583  
   584  
   585  | Field | Type | Label | Description |
   586  | ----- | ---- | ----- | ----------- |
   587  | state | [State](#proto.State) |  |  |
   588  
   589  
   590  
   591  
   592  
   593  
   594  
   595  <a name="proto.StatusCheckEvent"></a>
   596  #### StatusCheckEvent
   597  `StatusCheckEvent` describes if the status check for kubernetes rollout has started, is in progress, has succeeded or failed.
   598  
   599  
   600  | Field | Type | Label | Description |
   601  | ----- | ---- | ----- | ----------- |
   602  | status | [string](#string) |  |  |
   603  | message | [string](#string) |  |  |
   604  | err | [string](#string) |  | Deprecated. Use actionableErr.message. |
   605  | errCode | [enums.StatusCode](#proto.enums.StatusCode) |  | Deprecated. Use actionableErr.errCode. status code representing success or failure |
   606  | actionableErr | [ActionableErr](#proto.ActionableErr) |  | actionable error message |
   607  
   608  
   609  
   610  
   611  
   612  
   613  
   614  <a name="proto.StatusCheckState"></a>
   615  #### StatusCheckState
   616  `StatusCheckState` describes the state of status check of current deployed resources.
   617  
   618  
   619  | Field | Type | Label | Description |
   620  | ----- | ---- | ----- | ----------- |
   621  | status | [string](#string) |  |  |
   622  | resources | [StatusCheckState.ResourcesEntry](#proto.StatusCheckState.ResourcesEntry) | repeated | A map of `resource name -> status-check-state`. Where `resource-name` is the kubernetes resource name. The `status-check-state` can be <br> - `"Not started"`: indicates that `status-check` has just started. <br> - `"In progress"`: InProgress is sent after every resource check is complete. <br> - `"Succeeded"`: - `"Failed"`: |
   623  | statusCode | [enums.StatusCode](#proto.enums.StatusCode) |  | StatusCheck statusCode |
   624  
   625  
   626  
   627  
   628  
   629  
   630  
   631  <a name="proto.StatusCheckState.ResourcesEntry"></a>
   632  #### StatusCheckState.ResourcesEntry
   633  
   634  
   635  
   636  | Field | Type | Label | Description |
   637  | ----- | ---- | ----- | ----------- |
   638  | key | [string](#string) |  |  |
   639  | value | [string](#string) |  |  |
   640  
   641  
   642  
   643  
   644  
   645  
   646  
   647  <a name="proto.Suggestion"></a>
   648  #### Suggestion
   649  Suggestion defines the action a user needs to recover from an error.
   650  
   651  
   652  | Field | Type | Label | Description |
   653  | ----- | ---- | ----- | ----------- |
   654  | suggestionCode | [enums.SuggestionCode](#proto.enums.SuggestionCode) |  | code representing a suggestion |
   655  | action | [string](#string) |  | action represents the suggestion action |
   656  
   657  
   658  
   659  
   660  
   661  
   662  
   663  <a name="proto.TerminationEvent"></a>
   664  #### TerminationEvent
   665  `TerminationEvent` marks the end of the skaffold session
   666  
   667  
   668  | Field | Type | Label | Description |
   669  | ----- | ---- | ----- | ----------- |
   670  | status | [string](#string) |  | status oneof: Completed or Failed |
   671  | err | [ActionableErr](#proto.ActionableErr) |  | actionable error message |
   672  
   673  
   674  
   675  
   676  
   677  
   678  
   679  <a name="proto.TestEvent"></a>
   680  #### TestEvent
   681  `TestEvent` represents the status of a test, and is emitted by Skaffold
   682  anytime a test starts or completes, successfully or not.
   683  
   684  
   685  | Field | Type | Label | Description |
   686  | ----- | ---- | ----- | ----------- |
   687  | status | [string](#string) |  | test status oneof: InProgress, Completed, Failed |
   688  | actionableErr | [ActionableErr](#proto.ActionableErr) |  | actionable error message |
   689  
   690  
   691  
   692  
   693  
   694  
   695  
   696  <a name="proto.TestMetadata"></a>
   697  #### TestMetadata
   698  TestMetadata describes the test pipeline
   699  
   700  
   701  | Field | Type | Label | Description |
   702  | ----- | ---- | ----- | ----------- |
   703  | Testers | [TestMetadata.Tester](#proto.TestMetadata.Tester) | repeated |  |
   704  
   705  
   706  
   707  
   708  
   709  
   710  
   711  <a name="proto.TestMetadata.Tester"></a>
   712  #### TestMetadata.Tester
   713  
   714  
   715  
   716  | Field | Type | Label | Description |
   717  | ----- | ---- | ----- | ----------- |
   718  | type | [enums.TesterType](#proto.enums.TesterType) |  |  |
   719  | count | [int32](#int32) |  |  |
   720  
   721  
   722  
   723  
   724  
   725  
   726  
   727  <a name="proto.TestState"></a>
   728  #### TestState
   729  `TestState` describes the current state of the test
   730  
   731  
   732  | Field | Type | Label | Description |
   733  | ----- | ---- | ----- | ----------- |
   734  | status | [string](#string) |  | Status of the current test |
   735  | statusCode | [enums.StatusCode](#proto.enums.StatusCode) |  | Teststate status code |
   736  
   737  
   738  
   739  
   740  
   741  
   742  
   743  <a name="proto.TriggerRequest"></a>
   744  #### TriggerRequest
   745  
   746  
   747  
   748  | Field | Type | Label | Description |
   749  | ----- | ---- | ----- | ----------- |
   750  | state | [TriggerState](#proto.TriggerState) |  |  |
   751  
   752  
   753  
   754  
   755  
   756  
   757  
   758  <a name="proto.TriggerState"></a>
   759  #### TriggerState
   760  TriggerState represents trigger state for a given phase.
   761  
   762  
   763  | Field | Type | Label | Description |
   764  | ----- | ---- | ----- | ----------- |
   765  | enabled | [bool](#bool) |  | enable or disable a trigger state |
   766  
   767  
   768  
   769  
   770  
   771  
   772  
   773  <a name="proto.UserIntentRequest"></a>
   774  #### UserIntentRequest
   775  
   776  
   777  
   778  | Field | Type | Label | Description |
   779  | ----- | ---- | ----- | ----------- |
   780  | intent | [Intent](#proto.Intent) |  |  |
   781  
   782  
   783  
   784  
   785  
   786   <!-- end messages -->
   787  
   788   <!-- end HasExtensions -->
   789  
   790  
   791  
   792  
   793  
   794  <a name="proto.enums.BuildType"></a>
   795  
   796  ### BuildType
   797  Enum indicating build type i.e. local, cluster vs GCB
   798  
   799  | Name | Number | Description |
   800  | ---- |:------:| ----------- |
   801  | UNKNOWN_BUILD_TYPE | 0 | Could not determine Build Type |
   802  | CLUSTER | 1 | Cluster Build |
   803  | GCB | 2 | GCB Build |
   804  | LOCAL | 3 | Local Build |
   805  
   806  
   807  
   808  <a name="proto.enums.BuilderType"></a>
   809  
   810  ### BuilderType
   811  Enum indicating builders used
   812  
   813  | Name | Number | Description |
   814  | ---- |:------:| ----------- |
   815  | UNKNOWN_BUILDER_TYPE | 0 | Could not determine builder type |
   816  | JIB | 1 | JIB Builder |
   817  | BAZEL | 2 | Bazel Builder |
   818  | BUILDPACKS | 3 | Buildpacks Builder |
   819  | CUSTOM | 4 | Custom Builder |
   820  | KANIKO | 5 | Kaniko Builder |
   821  | DOCKER | 6 | Docker Builder |
   822  | KO | 7 | Ko Builder |
   823  
   824  
   825  
   826  <a name="proto.enums.ClusterType"></a>
   827  
   828  ### ClusterType
   829  Enum indicating cluster type the application is deployed to
   830  
   831  | Name | Number | Description |
   832  | ---- |:------:| ----------- |
   833  | UNKNOWN_CLUSTER_TYPE | 0 | Could not determine Cluster Type |
   834  | MINIKUBE | 1 | Minikube Cluster |
   835  | GKE | 2 | GKE cluster |
   836  | OTHER | 3 | All Cluster except Minikube and GKE |
   837  
   838  
   839  
   840  <a name="proto.enums.DeployerType"></a>
   841  
   842  ### DeployerType
   843  Enum indicating deploy tools used
   844  
   845  | Name | Number | Description |
   846  | ---- |:------:| ----------- |
   847  | UNKNOWN_DEPLOYER_TYPE | 0 | Could not determine Deployer Type |
   848  | HELM | 1 | Helm Deployer |
   849  | KUSTOMIZE | 2 | Kustomize Deployer |
   850  | KUBECTL | 3 | Kubectl Deployer |
   851  | KPT | 4 | kpt Deployer |
   852  
   853  
   854  
   855  <a name="proto.enums.LogLevel"></a>
   856  
   857  ### LogLevel
   858  Enum indicating the log level of a line of output
   859  
   860  | Name | Number | Description |
   861  | ---- |:------:| ----------- |
   862  | DEBUG | 0 | Debug Level |
   863  | INFO | 1 | Info Level |
   864  | WARN | 2 | Warn Level |
   865  | ERROR | 3 | Error Level |
   866  | FATAL | 4 | Fatal Level |
   867  | PANIC | 5 | Panic Level |
   868  | TRACE | 6 | Trace Level |
   869  | STANDARD | 7 | User-visible output level |
   870  
   871  
   872  
   873  <a name="proto.enums.RenderType"></a>
   874  
   875  ### RenderType
   876  Enum indicating render manifests type
   877  
   878  | Name | Number | Description |
   879  | ---- |:------:| ----------- |
   880  | UNKNOWN_RENDER_TYPE | 0 | Could not determine Render Type |
   881  | RAWK8S | 1 | Raw Manifests |
   882  | KUSTOMIZE_MANIFEST | 2 | kustomize manifests |
   883  | HELM_CHART | 3 | helm charts |
   884  | KPT_MANIFEST | 4 | kpt manifests |
   885  
   886  
   887  
   888  <a name="proto.enums.StatusCode"></a>
   889  
   890  ### StatusCode
   891  Enum for Status codes<br>
   892  These error codes are prepended by Phase Name e.g.
   893  INIT, BUILD, TEST, DEPLOY, STATUSCHECK, DEVINIT<br>
   894  For Success Error codes, use range 200 to 250.<br>
   895  For Unknown error codes, use range 500 to 600.<br>
   896  For Cancelled Error code, use range 800 to 850.<br>
   897  
   898  | Name | Number | Description |
   899  | ---- |:------:| ----------- |
   900  | OK | 0 | A default status code for events that do not have an associated phase. Typically seen with the DevEndEvent event on success. |
   901  | STATUSCHECK_SUCCESS | 200 | Status Check Success |
   902  | BUILD_SUCCESS | 201 | Build Success |
   903  | RENDER_SUCCESS | 204 | Render Success |
   904  | DEPLOY_SUCCESS | 202 | Deploy Success |
   905  | TEST_SUCCESS | 203 | Test Success |
   906  | BUILD_PUSH_ACCESS_DENIED | 101 | Build error due to push access denied |
   907  | BUILD_PROJECT_NOT_FOUND | 102 | Build error due to GCP project not found. |
   908  | BUILD_DOCKER_DAEMON_NOT_RUNNING | 103 | Docker build error due to docker daemon not running |
   909  | BUILD_USER_ERROR | 104 | Build error due to user application code, e.g. compilation error, dockerfile error etc |
   910  | BUILD_DOCKER_UNAVAILABLE | 105 | Build error due to docker not available |
   911  | BUILD_DOCKER_UNAUTHORIZED | 106 | Docker build error due to user not authorized to perform the action |
   912  | BUILD_DOCKER_SYSTEM_ERR | 107 | Docker system build error |
   913  | BUILD_DOCKER_NOT_MODIFIED_ERR | 108 | Docker build error due to Docker build container is already in the desired state |
   914  | BUILD_DOCKER_NOT_IMPLEMENTED_ERR | 109 | Docker build error indicating a feature not supported |
   915  | BUILD_DOCKER_DATA_LOSS_ERR | 110 | Docker build error indicates that for given build, data was lost or there is data corruption |
   916  | BUILD_DOCKER_FORBIDDEN_ERR | 111 | Docker build error indicates user is forbidden to perform the build or step/action. |
   917  | BUILD_DOCKER_CONFLICT_ERR | 112 | Docker build error due to some internal error and docker container state conflicts with the requested action and can't be performed |
   918  | BUILD_DOCKER_ERROR_NOT_FOUND | 113 | Docker build error indicates the requested object does not exist |
   919  | BUILD_DOCKER_INVALID_PARAM_ERR | 114 | Docker build error indication invalid parameter sent to docker command |
   920  | BUILD_DOCKERFILE_NOT_FOUND | 115 | Docker build failed due to dockerfile not found |
   921  | BUILD_DOCKER_CACHE_FROM_PULL_ERR | 116 | Docker build failed due `cacheFrom` user config error |
   922  | BUILD_DOCKER_GET_DIGEST_ERR | 117 | Build error due to digest for built artifact could not be retrieved from docker daemon. |
   923  | BUILD_DOCKER_NO_SPACE_ERR | 127 | Build error due no space left in docker. |
   924  | BUILD_REGISTRY_GET_DIGEST_ERR | 118 | Build error due to digest for built artifact could not be retrieved from registry. |
   925  | BUILD_UNKNOWN_JIB_PLUGIN_TYPE | 119 | Build error indicating unknown Jib plugin type. Should be one of [maven, gradle] |
   926  | BUILD_JIB_GRADLE_DEP_ERR | 120 | Build error determining dependency for jib gradle project. |
   927  | BUILD_JIB_MAVEN_DEP_ERR | 121 | Build error determining dependency for jib gradle project. |
   928  | INIT_DOCKER_NETWORK_LISTING_CONTAINERS | 122 | Docker build error when listing containers. |
   929  | INIT_DOCKER_NETWORK_INVALID_CONTAINER_NAME | 123 | Docker build error indicating an invalid container name (or id). |
   930  | INIT_DOCKER_NETWORK_CONTAINER_DOES_NOT_EXIST | 124 | Docker build error indicating the container referenced does not exists in the docker context used. |
   931  | INIT_DOCKER_NETWORK_INVALID_MODE | 125 | Docker Network invalid mode |
   932  | INIT_DOCKER_NETWORK_PARSE_ERR | 126 | Error parsing Docker Network mode |
   933  | BUILD_GCB_CREATE_BUILD_ERR | 128 | GCB Create Build Error |
   934  | BUILD_GCB_GET_BUILD_ID_ERR | 129 | GCB error indicating an error to fetch build id. |
   935  | BUILD_GCB_GET_BUILD_STATUS_ERR | 130 | GCB error indicating an error to fetch build status. |
   936  | BUILD_GCB_GET_BUILD_LOG_ERR | 131 | GCB error indicating an error to fetch build logs. |
   937  | BUILD_GCB_COPY_BUILD_LOG_ERR | 132 | GCB error indicating an error to fetch build status. |
   938  | BUILD_GCB_GET_BUILT_IMAGE_ERR | 133 | GCB error indicating an error retrieving the built image id. |
   939  | BUILD_GCB_BUILD_FAILED | 134 | GCB error indicating build failure. |
   940  | BUILD_GCB_BUILD_INTERNAL_ERR | 135 | GCB error indicating build failure due to internal errror. |
   941  | BUILD_GCB_BUILD_TIMEOUT | 136 | GCB error indicating build failure due to timeout. |
   942  | BUILD_GCB_GENERATE_BUILD_DESCRIPTOR_ERR | 137 | GCB error to generate the build descriptor. |
   943  | BUILD_GCB_UPLOAD_TO_GCS_ERR | 138 | GCB error to upload to GCS. |
   944  | BUILD_GCB_JIB_DEPENDENCY_ERR | 139 | GCB error to fetch jib artifact dependency. |
   945  | BUILD_GCB_GET_DEPENDENCY_ERR | 140 | GCB error to fetch artifact dependency. |
   946  | BUILD_GCB_GET_GCS_BUCKET_ERR | 141 | GCB error to get GCS bucket. |
   947  | BUILD_GCB_CREATE_BUCKET_ERR | 142 | GCB error to create a GCS bucket. |
   948  | BUILD_GCB_EXTRACT_PROJECT_ID | 143 | GCB error to extract Project ID. |
   949  | BUILD_GET_CLOUD_STORAGE_CLIENT_ERR | 144 | GCB error to get cloud storage client to perform GCS operation. |
   950  | BUILD_GET_CLOUD_BUILD_CLIENT_ERR | 145 | GCB error to get cloud build client to perform GCB operations. |
   951  | BUILD_UNKNOWN_PLATFORM_FLAG | 150 | Value provided to --platform flag cannot be parsed |
   952  | BUILD_CROSS_PLATFORM_ERR | 151 | Cross-platform build failures |
   953  | BUILD_CROSS_PLATFORM_NO_REGISTRY_ERR | 152 | Multi-platfor build fails due to no container registry set |
   954  | STATUSCHECK_IMAGE_PULL_ERR | 300 | Container image pull error |
   955  | STATUSCHECK_CONTAINER_CREATING | 301 | Container creating error |
   956  | STATUSCHECK_RUN_CONTAINER_ERR | 302 | Container run error |
   957  | STATUSCHECK_CONTAINER_TERMINATED | 303 | Container is already terminated |
   958  | STATUSCHECK_DEPLOYMENT_ROLLOUT_PENDING | 304 | Deployment waiting for rollout |
   959  | STATUSCHECK_STANDALONE_PODS_PENDING | 305 | Standalone pods pending to stabilize |
   960  | STATUSCHECK_CONTAINER_RESTARTING | 356 | Container restarting error |
   961  | STATUSCHECK_UNHEALTHY | 357 | Readiness probe failed |
   962  | STATUSCHECK_CONTAINER_EXEC_ERROR | 358 | Executable binary format error |
   963  | STATUSCHECK_NODE_MEMORY_PRESSURE | 400 | Node memory pressure error |
   964  | STATUSCHECK_NODE_DISK_PRESSURE | 401 | Node disk pressure error |
   965  | STATUSCHECK_NODE_NETWORK_UNAVAILABLE | 402 | Node network unavailable error |
   966  | STATUSCHECK_NODE_PID_PRESSURE | 403 | Node PID pressure error |
   967  | STATUSCHECK_NODE_UNSCHEDULABLE | 404 | Node unschedulable error |
   968  | STATUSCHECK_NODE_UNREACHABLE | 405 | Node unreachable error |
   969  | STATUSCHECK_NODE_NOT_READY | 406 | Node not ready error |
   970  | STATUSCHECK_FAILED_SCHEDULING | 407 | Scheduler failure error |
   971  | STATUSCHECK_KUBECTL_CONNECTION_ERR | 409 | Kubectl connection error |
   972  | STATUSCHECK_KUBECTL_PID_KILLED | 410 | Kubectl process killed error |
   973  | STATUSCHECK_KUBECTL_CLIENT_FETCH_ERR | 411 | Kubectl client fetch err |
   974  | STATUSCHECK_DEPLOYMENT_FETCH_ERR | 412 |  |
   975  | STATUSCHECK_STANDALONE_PODS_FETCH_ERR | 413 |  |
   976  | STATUSCHECK_CONFIG_CONNECTOR_RESOURCES_FETCH_ERR | 414 |  |
   977  | STATUSCHECK_STATEFULSET_FETCH_ERR | 415 |  |
   978  | STATUSCHECK_CUSTOM_RESOURCE_FETCH_ERR | 416 |  |
   979  | STATUSCHECK_POD_INITIALIZING | 451 | Pod Initializing |
   980  | STATUSCHECK_CONFIG_CONNECTOR_IN_PROGRESS | 452 | The actual state of the resource has not yet reached the desired state |
   981  | STATUSCHECK_CONFIG_CONNECTOR_FAILED | 453 | The process of reconciling the actual state with the desired state has encountered an error |
   982  | STATUSCHECK_CONFIG_CONNECTOR_TERMINATING | 454 | The resource is in the process of being deleted |
   983  | STATUSCHECK_CONFIG_CONNECTOR_NOT_FOUND | 455 | The resource does not exist |
   984  | STATUSCHECK_CUSTOM_RESOURCE_IN_PROGRESS | 456 | The actual state of the resource has not yet reached the desired state |
   985  | STATUSCHECK_CUSTOM_RESOURCE_FAILED | 457 | The process of reconciling the actual state with the desired state has encountered an error |
   986  | STATUSCHECK_CUSTOM_RESOURCE_TERMINATING | 458 | The resource is in the process of being deleted |
   987  | STATUSCHECK_CUSTOM_RESOURCE_NOT_FOUND | 459 | The resource does not exist |
   988  | UNKNOWN_ERROR | 500 | Could not determine error and phase |
   989  | STATUSCHECK_UNKNOWN | 501 | Status Check error unknown |
   990  | STATUSCHECK_UNKNOWN_UNSCHEDULABLE | 502 | Container is unschedulable due to unknown reasons |
   991  | STATUSCHECK_CONTAINER_WAITING_UNKNOWN | 503 | Container is waiting due to unknown reason |
   992  | STATUSCHECK_UNKNOWN_EVENT | 509 | Container event reason unknown |
   993  | STATUSCHECK_INTERNAL_ERROR | 514 | Status Check internal error |
   994  | DEPLOY_UNKNOWN | 504 | Deploy failed due to unknown reason |
   995  | SYNC_UNKNOWN | 505 | SYNC failed due to known reason |
   996  | BUILD_UNKNOWN | 506 | Build failed due to unknown reason |
   997  | DEVINIT_UNKNOWN | 507 | Dev Init failed due to unknown reason |
   998  | CLEANUP_UNKNOWN | 508 | Cleanup failed due to unknown reason |
   999  | INIT_UNKNOWN | 510 | Initialization of the Skaffold session failed due to unknown reason(s) |
  1000  | BUILD_DOCKER_UNKNOWN | 511 | Build failed due to docker unknown error |
  1001  | TEST_UNKNOWN | 512 | Test failed due to unknown reason |
  1002  | BUILD_GCB_BUILD_UNKNOWN_STATUS | 513 | GCB error indicating build failed due to unknown status. |
  1003  | SYNC_INIT_ERROR | 601 | File Sync Initialize failure |
  1004  | DEVINIT_REGISTER_BUILD_DEPS | 701 | Failed to configure watcher for build dependencies in dev loop |
  1005  | DEVINIT_REGISTER_TEST_DEPS | 702 | Failed to configure watcher for test dependencies in dev loop |
  1006  | DEVINIT_REGISTER_DEPLOY_DEPS | 703 | Failed to configure watcher for deploy dependencies in dev loop |
  1007  | DEVINIT_REGISTER_CONFIG_DEP | 704 | Failed to configure watcher for Skaffold configuration file. |
  1008  | DEVINIT_UNSUPPORTED_V1_MANIFEST | 705 | Failed to configure watcher for build dependencies for a base image with v1 manifest. |
  1009  | DEVINIT_REGISTER_RENDER_DEPS | 706 | Failed to configure watcher for render dependencies in dev loop |
  1010  | STATUSCHECK_USER_CANCELLED | 800 | User cancelled the skaffold dev run |
  1011  | STATUSCHECK_DEADLINE_EXCEEDED | 801 | Deadline for status check exceeded |
  1012  | BUILD_CANCELLED | 802 | Build Cancelled |
  1013  | DEPLOY_CANCELLED | 803 | Deploy cancelled due to user cancellation or one or more deployers failed. |
  1014  | BUILD_DOCKER_CANCELLED | 804 | Docker build cancelled. |
  1015  | BUILD_DOCKER_DEADLINE | 805 | Build error due to docker deadline was reached before the docker action completed |
  1016  | BUILD_GCB_BUILD_CANCELLED | 806 | GCB Build cancelled. |
  1017  | INIT_CREATE_TAGGER_ERROR | 901 | Skaffold was unable to create the configured tagger |
  1018  | INIT_MINIKUBE_PAUSED_ERROR | 902 | Skaffold was unable to start as Minikube appears to be paused |
  1019  | INIT_MINIKUBE_NOT_RUNNING_ERROR | 903 | Skaffold was unable to start as Minikube appears to be stopped |
  1020  | INIT_CREATE_BUILDER_ERROR | 904 | Skaffold was unable to create a configured image builder |
  1021  | INIT_CREATE_DEPLOYER_ERROR | 905 | Skaffold was unable to create a configured deployer |
  1022  | INIT_CREATE_TEST_DEP_ERROR | 906 | Skaffold was unable to create a configured test |
  1023  | INIT_CACHE_ERROR | 907 | Skaffold encountered an error validating the artifact cache |
  1024  | INIT_CREATE_WATCH_TRIGGER_ERROR | 908 | Skaffold encountered an error when configuring file watching |
  1025  | INIT_CREATE_ARTIFACT_DEP_ERROR | 909 | Skaffold encountered an error when evaluating artifact dependencies |
  1026  | INIT_CLOUD_RUN_LOCATION_ERROR | 910 | No Location was specified for Cloud Run |
  1027  | DEPLOY_CLUSTER_CONNECTION_ERR | 1001 | Unable to connect to cluster |
  1028  | DEPLOY_DEBUG_HELPER_RETRIEVE_ERR | 1002 | Could not retrieve debug helpers. |
  1029  | DEPLOY_CLEANUP_ERR | 1003 | Deploy clean up error |
  1030  | DEPLOY_HELM_APPLY_LABELS | 1004 | Unable to apply helm labels. |
  1031  | DEPLOY_HELM_USER_ERR | 1005 | Deploy error due to user deploy config for helm deployer |
  1032  | DEPLOY_NO_MATCHING_BUILD | 1006 | An image was referenced with no matching build result |
  1033  | DEPLOY_HELM_VERSION_ERR | 1007 | Unable to get helm client version |
  1034  | DEPLOY_HELM_MIN_VERSION_ERR | 1008 | Helm version not supported. |
  1035  | DEPLOY_KUBECTL_VERSION_ERR | 1109 | Unable to retrieve kubectl version |
  1036  | DEPLOY_KUBECTL_OFFLINE_MODE_ERR | 1010 | User specified offline mode for rendering but remote manifests presents. |
  1037  | DEPLOY_ERR_WAITING_FOR_DELETION | 1011 | Error waiting for previous version deletion before next version is active. |
  1038  | DEPLOY_READ_MANIFEST_ERR | 1012 | Error reading manifests |
  1039  | DEPLOY_READ_REMOTE_MANIFEST_ERR | 1013 | Error reading remote manifests |
  1040  | DEPLOY_LIST_MANIFEST_ERR | 1014 | Errors listing manifests |
  1041  | DEPLOY_KUBECTL_USER_ERR | 1015 | Deploy error due to user deploy config for kubectl deployer |
  1042  | DEPLOY_KUSTOMIZE_USER_ERR | 1016 | Deploy error due to user deploy config for kustomize deployer |
  1043  | DEPLOY_REPLACE_IMAGE_ERR | 1017 | Error replacing a built artifact in the manifests |
  1044  | DEPLOY_TRANSFORM_MANIFEST_ERR | 1018 | Error transforming a manifest during skaffold debug |
  1045  | DEPLOY_SET_LABEL_ERR | 1019 | Error setting user specified additional labels. |
  1046  | DEPLOY_MANIFEST_WRITE_ERR | 1020 | Error writing hydrated kubernetes manifests. |
  1047  | DEPLOY_PARSE_MANIFEST_IMAGES_ERR | 1021 | Error getting images from a kubernetes manifest. |
  1048  | DEPLOY_HELM_CREATE_NS_NOT_AVAILABLE | 1022 | Helm config `createNamespace` not available |
  1049  | DEPLOY_CLUSTER_INTERNAL_SYSTEM_ERR | 1023 | Kubernetes cluster reported an internal system error |
  1050  | DEPLOY_KPTFILE_INIT_ERR | 1024 | The Kptfile cannot be created via `kpt live init`. |
  1051  | DEPLOY_KPT_SOURCE_ERR | 1025 | The `kpt fn source` cannot read the given manifests. |
  1052  | DEPLOY_KPTFILE_INVALID_YAML_ERR | 1026 | The Kptfile exists but cannot be opened or parsed. |
  1053  | DEPLOY_KPT_APPLY_ERR | 1027 | kpt fails to live apply the manifests to the cluster. |
  1054  | DEPLOY_GET_CLOUD_RUN_CLIENT_ERR | 1028 | The Cloud Run Client could not be created |
  1055  | DEPLOY_CLOUD_RUN_GET_SERVICE_ERR | 1029 | The Cloud Run Client could not get details about the service. |
  1056  | DEPLOY_CLOUD_RUN_UPDATE_SERVICE_ERR | 1030 | The Cloud Run Client was unable to update the service. |
  1057  | DEPLOY_CLOUD_RUN_DELETE_SERVICE_ERR | 1031 | The Cloud Run Client was unable to delete the service. |
  1058  | TEST_USER_CONFIG_ERR | 1101 | Error expanding paths |
  1059  | TEST_CST_USER_ERR | 1102 | Error running container-structure-test |
  1060  | TEST_IMG_PULL_ERR | 1103 | Unable to docker pull image |
  1061  | TEST_CUSTOM_CMD_PARSE_ERR | 1104 | Unable to parse test command |
  1062  | TEST_CUSTOM_CMD_RUN_NON_ZERO_EXIT_ERR | 1105 | Command returned non-zero exit code |
  1063  | TEST_CUSTOM_CMD_RUN_TIMEDOUT_ERR | 1106 | command cancelled or timed out |
  1064  | TEST_CUSTOM_CMD_RUN_CANCELLED_ERR | 1107 | command cancelled or timed out |
  1065  | TEST_CUSTOM_CMD_RUN_EXECUTION_ERR | 1108 | command context error |
  1066  | TEST_CUSTOM_CMD_RUN_EXITED_ERR | 1110 | command exited |
  1067  | TEST_CUSTOM_CMD_RUN_ERR | 1111 | error running cmd |
  1068  | TEST_CUSTOM_DEPENDENCIES_CMD_ERR | 1112 | Error getting dependencies from command |
  1069  | TEST_CUSTOM_DEPENDENCIES_UNMARSHALL_ERR | 1113 | Unmarshalling dependency output error |
  1070  | TEST_CUSTOM_CMD_RETRIEVE_ERR | 1114 | Error retrieving the command |
  1071  | RENDER_KPTFILE_INIT_ERR | 1501 | Render errors The Kptfile cannot be created via `kpt pkg init`. |
  1072  | RENDER_KPTFILE_INVALID_YAML_ERR | 1401 | The Kptfile is not a valid yaml file |
  1073  | RENDER_KPTFILE_INVALID_SCHEMA_ERR | 1402 | The Kptfile is not a valid API schema |
  1074  | RENDER_SET_NAMESPACE_ERR | 1403 | Error setting namespace. |
  1075  | RENDER_NAMESPACE_ALREADY_SET_ERR | 1404 | Namespace is already set. |
  1076  | RENDER_REPLACE_IMAGE_ERR | 1405 | Error replacing a built artifact in the manifests |
  1077  | RENDER_TRANSFORM_MANIFEST_ERR | 1406 | Error transforming a manifest during skaffold debug |
  1078  | RENDER_SET_LABEL_ERR | 1407 | Error setting user specified additional labels. |
  1079  | RENDER_MANIFEST_WRITE_ERR | 1408 | Error writing hydrated kubernetes manifests. |
  1080  | RENDER_PARSE_MANIFEST_IMAGES_ERR | 1409 | Error getting images from a kubernetes manifest. |
  1081  | CONFIG_FILE_PARSING_ERR | 1201 | Catch-all configuration file parsing error |
  1082  | CONFIG_FILE_NOT_FOUND_ERR | 1202 | Main configuration file not found |
  1083  | CONFIG_DEPENDENCY_NOT_FOUND_ERR | 1203 | Dependency configuration file not found |
  1084  | CONFIG_DUPLICATE_NAMES_SAME_FILE_ERR | 1204 | Duplicate config names in the same configuration file |
  1085  | CONFIG_DUPLICATE_NAMES_ACROSS_FILES_ERR | 1205 | Duplicate config names in two configuration files |
  1086  | CONFIG_BAD_FILTER_ERR | 1206 | No configs matching configs filter |
  1087  | CONFIG_ZERO_FOUND_ERR | 1207 | No configs parsed from current file |
  1088  | CONFIG_APPLY_PROFILES_ERR | 1208 | Failed to apply profiles to config |
  1089  | CONFIG_DEFAULT_VALUES_ERR | 1209 | Failed to set default config values |
  1090  | CONFIG_FILE_PATHS_SUBSTITUTION_ERR | 1210 | Failed to substitute absolute file paths in config |
  1091  | CONFIG_MULTI_IMPORT_PROFILE_CONFLICT_ERR | 1211 | Same config imported at least twice with different set of profiles |
  1092  | CONFIG_PROFILES_NOT_FOUND_ERR | 1212 | Profile selection did not match known profile names |
  1093  | CONFIG_UNKNOWN_API_VERSION_ERR | 1213 | Config API version not found |
  1094  | CONFIG_UNKNOWN_VALIDATOR | 1214 | The validator is not allowed in skaffold-managed mode. |
  1095  | CONFIG_UNKNOWN_TRANSFORMER | 1215 | The transformer is not allowed in skaffold-managed mode. |
  1096  | CONFIG_MISSING_MANIFEST_FILE_ERR | 1216 | Manifest file not found |
  1097  | CONFIG_REMOTE_REPO_CACHE_NOT_FOUND_ERR | 1217 | Remote config repository cache not found and sync disabled |
  1098  | CONFIG_UPGRADE_ERR | 1218 | Skaffold config version mismatch |
  1099  | INSPECT_UNKNOWN_ERR | 1301 | Catch-all `skaffold inspect` command error |
  1100  | INSPECT_BUILD_ENV_ALREADY_EXISTS_ERR | 1302 | Trying to add new build environment that already exists |
  1101  | INSPECT_BUILD_ENV_INCORRECT_TYPE_ERR | 1303 | Trying to modify build environment that doesn't exist |
  1102  | INSPECT_PROFILE_NOT_FOUND_ERR | 1304 | Trying to modify a profile that doesn't exist |
  1103  | PORT_FORWARD_RUN_GCLOUD_NOT_FOUND | 1601 |  |
  1104  | PORT_FORWARD_RUN_PROXY_START_ERROR | 1602 |  |
  1105  | LOG_STREAM_RUN_GCLOUD_NOT_FOUND | 1603 | GCloud not found error |
  1106  
  1107  
  1108  
  1109  <a name="proto.enums.SuggestionCode"></a>
  1110  
  1111  ### SuggestionCode
  1112  Enum for Suggestion codes
  1113  
  1114  | Name | Number | Description |
  1115  | ---- |:------:| ----------- |
  1116  | NIL | 0 | default nil suggestion. This is usually set when no error happens. |
  1117  | ADD_DEFAULT_REPO | 100 | Add Default Repo |
  1118  | CHECK_DEFAULT_REPO | 101 | Verify Default Repo |
  1119  | CHECK_DEFAULT_REPO_GLOBAL_CONFIG | 102 | Verify default repo in the global config |
  1120  | GCLOUD_DOCKER_AUTH_CONFIGURE | 103 | run gcloud docker auth configure |
  1121  | DOCKER_AUTH_CONFIGURE | 104 | Run docker auth configure |
  1122  | CHECK_GCLOUD_PROJECT | 105 | Verify Gcloud Project |
  1123  | CHECK_DOCKER_RUNNING | 106 | Check if docker is running |
  1124  | FIX_USER_BUILD_ERR | 107 | Fix User Build Error |
  1125  | DOCKER_BUILD_RETRY | 108 | Docker build internal error, try again |
  1126  | FIX_CACHE_FROM_ARTIFACT_CONFIG | 109 | Fix `cacheFrom` config for given artifact and try again |
  1127  | FIX_SKAFFOLD_CONFIG_DOCKERFILE | 110 | Fix `dockerfile` config for a given artifact and try again. |
  1128  | FIX_JIB_PLUGIN_CONFIGURATION | 111 | Use a supported Jib plugin type |
  1129  | FIX_DOCKER_NETWORK_CONTAINER_NAME | 112 | Docker build network invalid docker container name (or id). |
  1130  | CHECK_DOCKER_NETWORK_CONTAINER_RUNNING | 113 | Docker build network container not existing in the current context. |
  1131  | FIX_DOCKER_NETWORK_MODE_WHEN_EXTRACTING_CONTAINER_NAME | 114 | Executing extractContainerNameFromNetworkMode with a non valid mode (only container mode allowed) |
  1132  | RUN_DOCKER_PRUNE | 115 | Prune Docker image |
  1133  | SET_CLEANUP_FLAG | 116 | Set Cleanup flag for skaffold command. |
  1134  | BUILD_FIX_UNKNOWN_PLATFORM_FLAG | 117 | Check value provided to the `--platform` flag |
  1135  | BUILD_INSTALL_PLATFORM_EMULATORS | 118 | Check if QEMU platform emulators are installed |
  1136  | SET_PUSH_AND_CONTAINER_REGISTRY | 119 | Set --push and container registry to run a multi-platform build |
  1137  | CHECK_CLUSTER_CONNECTION | 201 | Check cluster connection |
  1138  | CHECK_MINIKUBE_STATUS | 202 | Check minikube status |
  1139  | INSTALL_HELM | 203 | Install helm tool |
  1140  | UPGRADE_HELM | 204 | Upgrade helm tool |
  1141  | FIX_SKAFFOLD_CONFIG_HELM_ARTIFACT_OVERRIDES | 205 | Fix helm `releases.artifactOverrides` config to match with `build.artifacts` (no longer used in Skaffold v2) |
  1142  | UPGRADE_HELM32 | 206 | Upgrade helm version to v3.2.0 and higher. |
  1143  | FIX_SKAFFOLD_CONFIG_HELM_CREATE_NAMESPACE | 207 | Set `releases.createNamespace` to false. |
  1144  | INVALID_KPT_MANIFESTS | 208 | check the Kptfile validation. |
  1145  | ALIGN_KPT_INVENTORY | 209 | align the inventory info in kpt live apply. |
  1146  | INSTALL_KUBECTL | 220 | Install kubectl tool |
  1147  | SPECIFY_CLOUD_RUN_LOCATION | 230 | Specify Cloud Run Location |
  1148  | CHECK_CONTAINER_LOGS | 301 | Container run error |
  1149  | CHECK_READINESS_PROBE | 302 | Pod Health check error |
  1150  | CHECK_CONTAINER_IMAGE | 303 | Check Container image |
  1151  | ADDRESS_NODE_MEMORY_PRESSURE | 400 | Node pressure error |
  1152  | ADDRESS_NODE_DISK_PRESSURE | 401 | Node disk pressure error |
  1153  | ADDRESS_NODE_NETWORK_UNAVAILABLE | 402 | Node network unavailable error |
  1154  | ADDRESS_NODE_PID_PRESSURE | 403 | Node PID pressure error |
  1155  | ADDRESS_NODE_UNSCHEDULABLE | 404 | Node unschedulable error |
  1156  | ADDRESS_NODE_UNREACHABLE | 405 | Node unreachable error |
  1157  | ADDRESS_NODE_NOT_READY | 406 | Node not ready error |
  1158  | ADDRESS_FAILED_SCHEDULING | 407 | Scheduler failure error |
  1159  | CHECK_HOST_CONNECTION | 408 | Cluster Connectivity error |
  1160  | START_MINIKUBE | 501 | Minikube is stopped: use `minikube start` |
  1161  | UNPAUSE_MINIKUBE | 502 | Minikube is paused: use `minikube unpause` |
  1162  | RUN_DOCKER_PULL | 551 | Run Docker pull for the image with v1 manifest and try again. |
  1163  | SET_RENDER_FLAG_OFFLINE_FALSE | 600 | Rerun with correct offline flag value. |
  1164  | KPTFILE_MANUAL_INIT | 601 | Manually run `kpt pkg init` or `kpt live init` |
  1165  | KPTFILE_CHECK_YAML | 602 | Check if the Kptfile is correct. |
  1166  | REMOVE_NAMESPACE_FROM_MANIFESTS | 603 | Remove namespace from manifests |
  1167  | CONFIG_CHECK_FILE_PATH | 700 | Check configuration file path |
  1168  | CONFIG_CHECK_DEPENDENCY_DEFINITION | 701 | Check dependency config definition |
  1169  | CONFIG_CHANGE_NAMES | 702 | Change config name to avoid duplicates |
  1170  | CONFIG_CHECK_FILTER | 703 | Check config filter |
  1171  | CONFIG_CHECK_PROFILE_DEFINITION | 704 | Check profile definition in current config |
  1172  | CONFIG_CHECK_DEPENDENCY_PROFILES_SELECTION | 705 | Check active profile selection for dependency config |
  1173  | CONFIG_CHECK_PROFILE_SELECTION | 706 | Check profile selection flag |
  1174  | CONFIG_FIX_API_VERSION | 707 | Fix config API version or upgrade the skaffold binary |
  1175  | CONFIG_ALLOWLIST_VALIDATORS | 708 | Only the allow listed validators are acceptable in skaffold-managed mode. |
  1176  | CONFIG_ALLOWLIST_transformers | 709 | Only the allow listed transformers are acceptable in skaffold-managed mode. |
  1177  | CONFIG_FIX_MISSING_MANIFEST_FILE | 710 | Check mising manifest file section of config and fix as needed. |
  1178  | CONFIG_ENABLE_REMOTE_REPO_SYNC | 711 | Enable remote repo sync, or clone manually |
  1179  | CONFIG_FIX_SKAFFOLD_CONFIG_VERSION | 712 | Upgrade skaffold config version to latest |
  1180  | INSPECT_USE_MODIFY_OR_NEW_PROFILE | 800 | Create new build env in a profile instead, or use the 'modify' command |
  1181  | INSPECT_USE_ADD_BUILD_ENV | 801 | Check profile selection, or use the 'add' command instead |
  1182  | INSPECT_CHECK_INPUT_PROFILE | 802 | Check profile flag value |
  1183  | OPEN_ISSUE | 900 | Open an issue so this situation can be diagnosed |
  1184  | CHECK_CUSTOM_COMMAND | 1000 | Test error suggestion codes |
  1185  | FIX_CUSTOM_COMMAND_TIMEOUT | 1001 |  |
  1186  | CHECK_CUSTOM_COMMAND_DEPENDENCIES_CMD | 1002 |  |
  1187  | CHECK_CUSTOM_COMMAND_DEPENDENCIES_PATHS | 1003 |  |
  1188  | CHECK_TEST_COMMAND_AND_IMAGE_NAME | 1004 |  |
  1189  
  1190  
  1191  
  1192  <a name="proto.enums.TesterType"></a>
  1193  
  1194  ### TesterType
  1195  Enum indicating test tools used
  1196  
  1197  | Name | Number | Description |
  1198  | ---- |:------:| ----------- |
  1199  | UNKNOWN_TEST_TYPE | 0 | Could not determine Test Type |
  1200  | UNIT | 1 | Unit tests |
  1201  | CONTAINER_STRUCTURE_TEST | 2 | Container Structure tests |
  1202  
  1203  
  1204   <!-- end enums -->