Files
Thomas DesrosiersandGitHub 8e5f88ca35 [core] Bump Go Dependencies (#2205)
* bump ./proto deps

* bump ./apiserver deps

* bump ./ray-operator deps

* bump ./cli deps

* bump ./experimental deps

* fixup! bump ./ray-operator deps

* Doesn't seem to matter but also bump buildkite

* Don't change the distro version just yet

* Bump go version in gha jobs

* Also bump sigs.k8s.io/controller-tools for build time

* more bumps

* Update package import paths for proto rename

* Fix another deprecated API

* s/corev1.ResourceRequirements/corev1.VolumeResourceRequirements/gci rename

* Downgrade client-go

* update-codegen.sh

* Try bumping crd-ref-docs as well

* make manifests

* make sync

* k8s.io/utils/pointer -> k8s.io/utils/ptr

* lint: missing formatting directive

* make generate

* Try to bump version

* Bump & standardize builder images

* fixup! Bump & standardize builder images

* Switch multi-arch Dockerfile to distrolss as well
2024-06-26 16:08:34 -07:00
..
2024-06-26 16:08:34 -07:00
2024-06-26 16:08:34 -07:00
2024-06-26 16:08:34 -07:00

Protocol Buffer API Definitions

This directory contains API definitions written in Protocol Buffers. These definitions will be used for building services.

Prerequisites

To successfully run the generation commands, ensure the following tools are installed in your environment:

Run the following command to build the proto-generator image. This image will be used for generating APIs:

Note: You can actually skip this step, and a prebuilt image will be downloaded instead.

make build-image

Automatic Generation

Go Client and Swagger

make generate

Clients

We postpone the client generation until there is a need for external service communication.

API Reference Documentation

Use the tools bootprint-openapi and html-inline to generate API reference documentation from the Swagger files. For more information on the API and architecture, refer to the design document.

Third-Party Protos

Third-party proto dependencies are synchronized back to proto/third_party for easier development (IDE friendly). Ideally, the directory for searching imports should be specified instead.

protoc -I.
    -I/go/src/github.com/grpc-ecosystem/grpc-gateway/third_party/googleapis \
    -I/go/src/github.com/grpc-ecosystem/grpc-gateway/ \
    -I/go/src/github.com/grpc-ecosystem/grpc-gateway/protoc-gen-swagger/options/ \

Sources: