README
¶
SDK
This repository contains the public gRPC protos supporting our services and packages to ease integration with the Chainguard platform.
Updating *.proto files
After updating a *.proto you'll need to update the corresponding generated go
code.
./hack/update-codegen.sh
Prerequisites
Install protoc: https://grpc.io/docs/protoc-installation/
Example for MacOS:
brew install protobuf
We currently require protoc v5.28.1.
Install protoc codegen dependencies:
go install google.golang.org/protobuf/cmd/protoc-gen-go@v1.34.2
go install google.golang.org/grpc/cmd/protoc-gen-go-grpc@v1.5.1
go install github.com/grpc-ecosystem/grpc-gateway/v2/protoc-gen-grpc-gateway@v2.22.0
go install github.com/grpc-ecosystem/grpc-gateway/v2/protoc-gen-openapiv2@v2.22.0
Directories
¶
| Path | Synopsis |
|---|---|
|
login
Package login implements client login functionality shared between various clients
|
Package login implements client login functionality shared between various clients |
|
Package civil implements types for civil time, a time-zone-independent representation of time that follows the rules of the proleptic Gregorian calendar with exactly 24-hour days, 60-minute hours, and 60-second minutes.
|
Package civil implements types for civil time, a time-zone-independent representation of time that follows the rules of the proleptic Gregorian calendar with exactly 24-hour days, 60-minute hours, and 60-second minutes. |
|
proto
|
|
|
annotations
Package accounts contains the GRPC client and server definitions for implementing Auth interactions for the Console.
|
Package accounts contains the GRPC client and server definitions for implementing Auth interactions for the Console. |
|
capabilities
Package capabilities contains the proto enum with our IAM capabilities.
|
Package capabilities contains the proto enum with our IAM capabilities. |
|
platform/advisory/v1
Package v1 contains the v1 GRPC client and server definitions for implementing Advisory interactions.
|
Package v1 contains the v1 GRPC client and server definitions for implementing Advisory interactions. |
|
platform/apk/v1
Package v1 contains the v1 GRPC client and server definitions for implementing APK interactions.
|
Package v1 contains the v1 GRPC client and server definitions for implementing APK interactions. |
|
platform/auth/v1
Package v1 contains the v1 GRPC client and server definitions for implementing Auth interactions for the Console.
|
Package v1 contains the v1 GRPC client and server definitions for implementing Auth interactions for the Console. |
|
platform/common/v1
Package common contains Chainguard shared types exposed to the console.
|
Package common contains Chainguard shared types exposed to the console. |
|
platform/events/v1
Package events contains the GRPC client and server definitions for implementing eventing interactions for the Console.
|
Package events contains the GRPC client and server definitions for implementing eventing interactions for the Console. |
|
platform/iam/v1
Package v1 contains the v1 GRPC client and server definitions for implementing IAM interactions for the Console.
|
Package v1 contains the v1 GRPC client and server definitions for implementing IAM interactions for the Console. |
|
platform/notifications/v1
Package v1 contains the v1 GRPC client and server definitions for implementing notifications interactions for the Platform.
|
Package v1 contains the v1 GRPC client and server definitions for implementing notifications interactions for the Platform. |
|
platform/oidc/v1
Package v1 contains the v1 GRPC client and server definitions for implementing OIDC interactions for the Platform.
|
Package v1 contains the v1 GRPC client and server definitions for implementing OIDC interactions for the Platform. |
|
platform/ping/v1
Package v1 contains the v1 GRPC client and server definitions for implementing ping interactions for the Platform.
|
Package v1 contains the v1 GRPC client and server definitions for implementing ping interactions for the Platform. |
|
platform/registry/v1
Package v1 contains the v1 GRPC client and server definitions for implementing Registry interactions.
|
Package v1 contains the v1 GRPC client and server definitions for implementing Registry interactions. |
|
platform/tenant/v1
Package v1 contains the v1 GRPC client and server definitions for implementing Tenant interactions for the Console.
|
Package v1 contains the v1 GRPC client and server definitions for implementing Tenant interactions for the Console. |
|
Package uidp contains utilities for reasoning about and manipulating the Chainguard IAM "UIDP" (UID Path) concept.
|
Package uidp contains utilities for reasoning about and manipulating the Chainguard IAM "UIDP" (UID Path) concept. |
Click to show internal directories.
Click to hide internal directories.