Categorygithub.com/coreos/rocketapiv1alpha
package
1.30.0
Repository: https://github.com/coreos/rocket.git
Documentation: pkg.go.dev
Overview
Versions
2
Dependencies
5
Dependents
0
Files
1.5k SLOC

# README

WARNING

The API defined here is proposed, experimental, and (for now) subject to change at any time.

If you think you want to use it, or for any other queries, contact [email protected] or file an issue

For more information, see:

Protobuf

The rkt gRPC API uses Protocol Buffers for its services. In order to rebuild the generated code make sure you have protobuf 3.0.0 installed (https://github.com/google/protobuf) and execute from the top-level directory:

$ make protobuf

Documentation

HTML and Markdown Protobuf documentation is automatically generated and placed in docs.

# Functions

No description provided by the author
No description provided by the author

# Constants

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
App events.
Image events.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Pod events.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
States that indicates the pod is exited, and will never run.
No description provided by the author
States before the pod is running.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
State that indicates the pod is running.
No description provided by the author

# Variables

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Structs

App describes the information of an app that's running in a pod.
Event describes the events that will be received via ListenEvents().
EventFilter defines the condition that the returned events needs to satisfy in ListImages().
Request for GetInfo().
Response for GetInfo().
Request for GetLogs().
Response for GetLogs().
GlobalFlags describes the flags that passed to rkt api service when it is launched.
Image describes the image's information.
ImageFilter defines the condition that the returned images need to satisfy in ListImages().
ImageFormat defines the format of the image.
Info describes the information of rkt on the machine.
Request for InspectImage().
Response for InspectImage().
Request for InspectPod().
Response for InspectPod().
No description provided by the author
Request for ListenEvents().
Response for ListenEvents().
Request for ListImages().
Response for ListImages().
Request for ListPods().
Response for ListPods().
Network describes the network information of a pod.
Pod describes a pod's information.
PodFilter defines the condition that the returned pods need to satisfy in ListPods().

# Interfaces

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Type aliases

AppState defines the possible states of the app.
EventType defines the type of the events that will be received via ListenEvents().
ImageType defines the supported image type.
PodState defines the possible states of the pod.