commonv1

package
v0.65.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 26, 2026 License: AGPL-3.0 Imports: 6 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source
var File_common_v1_common_proto protoreflect.FileDescriptor

Functions

This section is empty.

Types

type BlueprintSummary

type BlueprintSummary struct {

	// name is the unique identifier of the blueprint.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// description is a short human-readable summary of what the blueprint provides.
	Description string `protobuf:"bytes,2,opt,name=description,proto3" json:"description,omitempty"`
	// is_template indicates whether this blueprint is a base template that other
	// blueprints may derive from.
	IsTemplate bool `protobuf:"varint,3,opt,name=is_template,json=isTemplate,proto3" json:"is_template,omitempty"`
	// org is the organization this blueprint is scoped to. Empty for a
	// file-based, global blueprint that every organization can see.
	Org string `protobuf:"bytes,4,opt,name=org,proto3" json:"org,omitempty"`
	// is_global is true when the blueprint is not scoped to any organization
	// (org is empty) and is therefore available to every organization.
	IsGlobal bool `protobuf:"varint,5,opt,name=is_global,json=isGlobal,proto3" json:"is_global,omitempty"`
	// template is the name of the parent template this blueprint derives from,
	// or empty when it does not inherit from one.
	Template string `protobuf:"bytes,6,opt,name=template,proto3" json:"template,omitempty"`
	// created_at is when the blueprint was first registered. For an org-scoped
	// database blueprint this is the row's creation time; for a file-based
	// blueprint it is the source file's last-modified time (equal to
	// updated_at), since a file has no separate creation record.
	CreatedAt *timestamp.Timestamp `protobuf:"bytes,7,opt,name=created_at,json=createdAt,proto3" json:"created_at,omitempty"`
	// updated_at is when the blueprint was last changed. For an org-scoped
	// database blueprint this is the row's last-update time; for a file-based
	// blueprint it is the source file's last-modified time (equal to
	// created_at).
	UpdatedAt *timestamp.Timestamp `protobuf:"bytes,8,opt,name=updated_at,json=updatedAt,proto3" json:"updated_at,omitempty"`
	// revision is a short content hash of the blueprint fully merged with its
	// inherited templates. It changes whenever the blueprint's effective
	// content changes, including through a change to any ancestor template.
	Revision string `protobuf:"bytes,9,opt,name=revision,proto3" json:"revision,omitempty"`
	// contains filtered or unexported fields
}

BlueprintSummary is a lightweight representation of a blueprint used in listing responses.

func (*BlueprintSummary) Descriptor deprecated

func (*BlueprintSummary) Descriptor() ([]byte, []int)

Deprecated: Use BlueprintSummary.ProtoReflect.Descriptor instead.

func (*BlueprintSummary) GetCreatedAt added in v0.49.0

func (x *BlueprintSummary) GetCreatedAt() *timestamp.Timestamp

func (*BlueprintSummary) GetDescription

func (x *BlueprintSummary) GetDescription() string

func (*BlueprintSummary) GetIsGlobal added in v0.49.0

func (x *BlueprintSummary) GetIsGlobal() bool

func (*BlueprintSummary) GetIsTemplate

func (x *BlueprintSummary) GetIsTemplate() bool

func (*BlueprintSummary) GetName

func (x *BlueprintSummary) GetName() string

func (*BlueprintSummary) GetOrg added in v0.49.0

func (x *BlueprintSummary) GetOrg() string

func (*BlueprintSummary) GetRevision added in v0.63.7

func (x *BlueprintSummary) GetRevision() string

func (*BlueprintSummary) GetTemplate added in v0.49.0

func (x *BlueprintSummary) GetTemplate() string

func (*BlueprintSummary) GetUpdatedAt added in v0.49.0

func (x *BlueprintSummary) GetUpdatedAt() *timestamp.Timestamp

func (*BlueprintSummary) ProtoMessage

func (*BlueprintSummary) ProtoMessage()

func (*BlueprintSummary) ProtoReflect

func (x *BlueprintSummary) ProtoReflect() protoreflect.Message

func (*BlueprintSummary) Reset

func (x *BlueprintSummary) Reset()

func (*BlueprintSummary) String

func (x *BlueprintSummary) String() string

type CompleteUserWebFlow

type CompleteUserWebFlow struct {

	// code is the authorization code returned by the provider.
	Code string `protobuf:"bytes,2,opt,name=code,proto3" json:"code,omitempty"`
	// state is the CSRF token that must match the value from OnboardUserWebFlow.
	State string `protobuf:"bytes,3,opt,name=state,proto3" json:"state,omitempty"`
	// contains filtered or unexported fields
}

CompleteUserWebFlow carries the callback parameters returned by the provider after the user completes the web authorization flow.

func (*CompleteUserWebFlow) Descriptor deprecated

func (*CompleteUserWebFlow) Descriptor() ([]byte, []int)

Deprecated: Use CompleteUserWebFlow.ProtoReflect.Descriptor instead.

func (*CompleteUserWebFlow) GetCode

func (x *CompleteUserWebFlow) GetCode() string

func (*CompleteUserWebFlow) GetState

func (x *CompleteUserWebFlow) GetState() string

func (*CompleteUserWebFlow) ProtoMessage

func (*CompleteUserWebFlow) ProtoMessage()

func (*CompleteUserWebFlow) ProtoReflect

func (x *CompleteUserWebFlow) ProtoReflect() protoreflect.Message

func (*CompleteUserWebFlow) Reset

func (x *CompleteUserWebFlow) Reset()

func (*CompleteUserWebFlow) String

func (x *CompleteUserWebFlow) String() string

type GetVersionInfoRequest added in v0.49.0

type GetVersionInfoRequest struct {
	// contains filtered or unexported fields
}

GetVersionInfoRequest is the input to the GetVersionInfo RPC that every k8Shell gRPC service exposes. It carries no fields today; it is kept as a named message rather than google.protobuf.Empty so parameters can be added later without changing the RPC signature.

func (*GetVersionInfoRequest) Descriptor deprecated added in v0.49.0

func (*GetVersionInfoRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetVersionInfoRequest.ProtoReflect.Descriptor instead.

func (*GetVersionInfoRequest) ProtoMessage added in v0.49.0

func (*GetVersionInfoRequest) ProtoMessage()

func (*GetVersionInfoRequest) ProtoReflect added in v0.49.0

func (x *GetVersionInfoRequest) ProtoReflect() protoreflect.Message

func (*GetVersionInfoRequest) Reset added in v0.49.0

func (x *GetVersionInfoRequest) Reset()

func (*GetVersionInfoRequest) String added in v0.49.0

func (x *GetVersionInfoRequest) String() string

type GetVersionInfoResponse added in v0.49.0

type GetVersionInfoResponse struct {

	// version is the service's released semantic version (e.g. "1.4.2"), or a
	// development placeholder such as "dev" for an unreleased build.
	Version string `protobuf:"bytes,1,opt,name=version,proto3" json:"version,omitempty"`
	// commit_id is the git commit SHA the service binary was built from.
	CommitId string `protobuf:"bytes,2,opt,name=commit_id,json=commitId,proto3" json:"commit_id,omitempty"`
	// description is a short human-readable summary of what the service does.
	Description string `protobuf:"bytes,3,opt,name=description,proto3" json:"description,omitempty"`
	// contains filtered or unexported fields
}

GetVersionInfoResponse reports build and version metadata for a single k8Shell service, as returned by its GetVersionInfo RPC.

func (*GetVersionInfoResponse) Descriptor deprecated added in v0.49.0

func (*GetVersionInfoResponse) Descriptor() ([]byte, []int)

Deprecated: Use GetVersionInfoResponse.ProtoReflect.Descriptor instead.

func (*GetVersionInfoResponse) GetCommitId added in v0.49.0

func (x *GetVersionInfoResponse) GetCommitId() string

func (*GetVersionInfoResponse) GetDescription added in v0.49.0

func (x *GetVersionInfoResponse) GetDescription() string

func (*GetVersionInfoResponse) GetVersion added in v0.49.0

func (x *GetVersionInfoResponse) GetVersion() string

func (*GetVersionInfoResponse) ProtoMessage added in v0.49.0

func (*GetVersionInfoResponse) ProtoMessage()

func (*GetVersionInfoResponse) ProtoReflect added in v0.49.0

func (x *GetVersionInfoResponse) ProtoReflect() protoreflect.Message

func (*GetVersionInfoResponse) Reset added in v0.49.0

func (x *GetVersionInfoResponse) Reset()

func (*GetVersionInfoResponse) String added in v0.49.0

func (x *GetVersionInfoResponse) String() string

type OnboardUserDeviceFlow

type OnboardUserDeviceFlow struct {

	// provider identifies the OAuth/OIDC provider initiating the flow (e.g. "github").
	Provider string `protobuf:"bytes,1,opt,name=provider,proto3" json:"provider,omitempty"`
	// username is the k8Shell user being onboarded.
	Username string `protobuf:"bytes,2,opt,name=username,proto3" json:"username,omitempty"`
	// user_code is the short code the user enters on the verification page.
	UserCode string `protobuf:"bytes,3,opt,name=user_code,json=userCode,proto3" json:"user_code,omitempty"`
	// verification_url is the URL the user visits to authorise the device.
	VerificationUrl string `protobuf:"bytes,4,opt,name=verification_url,json=verificationUrl,proto3" json:"verification_url,omitempty"`
	// expires_in is the number of seconds until the user_code expires.
	ExpiresIn int32 `protobuf:"varint,5,opt,name=expires_in,json=expiresIn,proto3" json:"expires_in,omitempty"`
	// contains filtered or unexported fields
}

OnboardUserDeviceFlow carries the data needed to complete a Device Authorization Grant (RFC 8628) onboarding flow.

func (*OnboardUserDeviceFlow) Descriptor deprecated

func (*OnboardUserDeviceFlow) Descriptor() ([]byte, []int)

Deprecated: Use OnboardUserDeviceFlow.ProtoReflect.Descriptor instead.

func (*OnboardUserDeviceFlow) GetExpiresIn

func (x *OnboardUserDeviceFlow) GetExpiresIn() int32

func (*OnboardUserDeviceFlow) GetProvider

func (x *OnboardUserDeviceFlow) GetProvider() string

func (*OnboardUserDeviceFlow) GetUserCode

func (x *OnboardUserDeviceFlow) GetUserCode() string

func (*OnboardUserDeviceFlow) GetUsername

func (x *OnboardUserDeviceFlow) GetUsername() string

func (*OnboardUserDeviceFlow) GetVerificationUrl

func (x *OnboardUserDeviceFlow) GetVerificationUrl() string

func (*OnboardUserDeviceFlow) ProtoMessage

func (*OnboardUserDeviceFlow) ProtoMessage()

func (*OnboardUserDeviceFlow) ProtoReflect

func (x *OnboardUserDeviceFlow) ProtoReflect() protoreflect.Message

func (*OnboardUserDeviceFlow) Reset

func (x *OnboardUserDeviceFlow) Reset()

func (*OnboardUserDeviceFlow) String

func (x *OnboardUserDeviceFlow) String() string

type OnboardUserRule added in v0.40.0

type OnboardUserRule struct {

	// username is the k8Shell user this decision applies to.
	Username string `protobuf:"bytes,1,opt,name=username,proto3" json:"username,omitempty"`
	// fullname is the user's display name, if known.
	Fullname string `protobuf:"bytes,2,opt,name=fullname,proto3" json:"fullname,omitempty"`
	// email is the user's email address, if known.
	Email string `protobuf:"bytes,3,opt,name=email,proto3" json:"email,omitempty"`
	// sudo indicates whether the user should be granted sudo in their
	// workspace. Unset when the template did not make a determination.
	Sudo *bool `protobuf:"varint,4,opt,name=sudo,proto3,oneof" json:"sudo,omitempty"`
	// action is one of "allow", "reject", "waitlist", "not-defined".
	Action string `protobuf:"bytes,5,opt,name=action,proto3" json:"action,omitempty"`
	// roles lists the RBAC roles to assign the user when action is "allow".
	Roles []string `protobuf:"bytes,6,rep,name=roles,proto3" json:"roles,omitempty"`
	// organization is the tenant the user should be placed into, if known.
	Organization string `protobuf:"bytes,7,opt,name=organization,proto3" json:"organization,omitempty"`
	// uid, when non-zero, pins the onboarded user to a specific unix uid
	// instead of letting the identity service auto-allocate the next
	// available one.
	Uid uint32 `protobuf:"varint,8,opt,name=uid,proto3" json:"uid,omitempty"`
	// gid, when non-zero, pins the onboarded user to a specific unix gid.
	// Defaults to uid when uid is set but gid is not.
	Gid uint32 `protobuf:"varint,9,opt,name=gid,proto3" json:"gid,omitempty"`
	// contains filtered or unexported fields
}

OnboardUserRule carries the onboarding decision an identity provider computes for a single user, typically evaluated via a CEL template against data the provider holds for that user. Unlike identity.v1.OnboardRule, this is not a persisted policy row — it is the provider's proposed disposition for this one user.

func (*OnboardUserRule) Descriptor deprecated added in v0.40.0

func (*OnboardUserRule) Descriptor() ([]byte, []int)

Deprecated: Use OnboardUserRule.ProtoReflect.Descriptor instead.

func (*OnboardUserRule) GetAction added in v0.40.0

func (x *OnboardUserRule) GetAction() string

func (*OnboardUserRule) GetEmail added in v0.40.0

func (x *OnboardUserRule) GetEmail() string

func (*OnboardUserRule) GetFullname added in v0.40.0

func (x *OnboardUserRule) GetFullname() string

func (*OnboardUserRule) GetGid added in v0.42.0

func (x *OnboardUserRule) GetGid() uint32

func (*OnboardUserRule) GetOrganization added in v0.40.0

func (x *OnboardUserRule) GetOrganization() string

func (*OnboardUserRule) GetRoles added in v0.40.0

func (x *OnboardUserRule) GetRoles() []string

func (*OnboardUserRule) GetSudo added in v0.40.0

func (x *OnboardUserRule) GetSudo() bool

func (*OnboardUserRule) GetUid added in v0.42.0

func (x *OnboardUserRule) GetUid() uint32

func (*OnboardUserRule) GetUsername added in v0.40.0

func (x *OnboardUserRule) GetUsername() string

func (*OnboardUserRule) ProtoMessage added in v0.40.0

func (*OnboardUserRule) ProtoMessage()

func (*OnboardUserRule) ProtoReflect added in v0.40.0

func (x *OnboardUserRule) ProtoReflect() protoreflect.Message

func (*OnboardUserRule) Reset added in v0.40.0

func (x *OnboardUserRule) Reset()

func (*OnboardUserRule) String added in v0.40.0

func (x *OnboardUserRule) String() string

type OnboardUserWebFlow

type OnboardUserWebFlow struct {

	// provider identifies the OAuth/OIDC provider (e.g. "github").
	Provider string `protobuf:"bytes,1,opt,name=provider,proto3" json:"provider,omitempty"`
	// auth_url is the provider's authorization endpoint the user should be
	// redirected to.
	AuthUrl string `protobuf:"bytes,2,opt,name=auth_url,json=authUrl,proto3" json:"auth_url,omitempty"`
	// state is the CSRF token that must be verified when the callback is received.
	State string `protobuf:"bytes,3,opt,name=state,proto3" json:"state,omitempty"`
	// expires_in is the number of seconds until the flow expires.
	ExpiresIn int32 `protobuf:"varint,4,opt,name=expires_in,json=expiresIn,proto3" json:"expires_in,omitempty"`
	// contains filtered or unexported fields
}

OnboardUserWebFlow carries the data needed to initiate an Authorization Code (web redirect) onboarding flow.

func (*OnboardUserWebFlow) Descriptor deprecated

func (*OnboardUserWebFlow) Descriptor() ([]byte, []int)

Deprecated: Use OnboardUserWebFlow.ProtoReflect.Descriptor instead.

func (*OnboardUserWebFlow) GetAuthUrl

func (x *OnboardUserWebFlow) GetAuthUrl() string

func (*OnboardUserWebFlow) GetExpiresIn

func (x *OnboardUserWebFlow) GetExpiresIn() int32

func (*OnboardUserWebFlow) GetProvider

func (x *OnboardUserWebFlow) GetProvider() string

func (*OnboardUserWebFlow) GetState

func (x *OnboardUserWebFlow) GetState() string

func (*OnboardUserWebFlow) ProtoMessage

func (*OnboardUserWebFlow) ProtoMessage()

func (*OnboardUserWebFlow) ProtoReflect

func (x *OnboardUserWebFlow) ProtoReflect() protoreflect.Message

func (*OnboardUserWebFlow) Reset

func (x *OnboardUserWebFlow) Reset()

func (*OnboardUserWebFlow) String

func (x *OnboardUserWebFlow) String() string

type PodLabelSelector added in v0.49.0

type PodLabelSelector struct {
	MatchLabels map[string]string `` /* 168-byte string literal not displayed */
	// contains filtered or unexported fields
}

PodLabelSelector is a set of pod labels an egress rule targets, matching one entry of a blueprint's network.allowEgressToPods shorthand list.

func (*PodLabelSelector) Descriptor deprecated added in v0.49.0

func (*PodLabelSelector) Descriptor() ([]byte, []int)

Deprecated: Use PodLabelSelector.ProtoReflect.Descriptor instead.

func (*PodLabelSelector) GetMatchLabels added in v0.49.0

func (x *PodLabelSelector) GetMatchLabels() map[string]string

func (*PodLabelSelector) ProtoMessage added in v0.49.0

func (*PodLabelSelector) ProtoMessage()

func (*PodLabelSelector) ProtoReflect added in v0.49.0

func (x *PodLabelSelector) ProtoReflect() protoreflect.Message

func (*PodLabelSelector) Reset added in v0.49.0

func (x *PodLabelSelector) Reset()

func (*PodLabelSelector) String added in v0.49.0

func (x *PodLabelSelector) String() string

type User

type User struct {

	// username is the unique login name of the user.
	Username string `protobuf:"bytes,1,opt,name=username,proto3" json:"username,omitempty"`
	// organization is the tenant the user belongs to.
	Organization string `protobuf:"bytes,2,opt,name=organization,proto3" json:"organization,omitempty"`
	// is_valid indicates whether the user's session or token is currently valid.
	IsValid bool `protobuf:"varint,3,opt,name=is_valid,json=isValid,proto3" json:"is_valid,omitempty"`
	// expires_at is the time at which the user's session expires.
	ExpiresAt *timestamp.Timestamp `protobuf:"bytes,4,opt,name=expires_at,json=expiresAt,proto3" json:"expires_at,omitempty"`
	// uid is the POSIX user ID assigned to the user.
	Uid uint32 `protobuf:"varint,5,opt,name=uid,proto3" json:"uid,omitempty"`
	// gid is the POSIX primary group ID assigned to the user.
	Gid uint32 `protobuf:"varint,6,opt,name=gid,proto3" json:"gid,omitempty"`
	// fullname is the display name of the user.
	Fullname string `protobuf:"bytes,7,opt,name=fullname,proto3" json:"fullname,omitempty"`
	// email is the user's email address.
	Email string `protobuf:"bytes,9,opt,name=email,proto3" json:"email,omitempty"`
	// password is the hashed password. Never populated in read responses.
	Password string `protobuf:"bytes,10,opt,name=password,proto3" json:"password,omitempty"`
	// locked indicates whether the account has been administratively locked.
	Locked bool `protobuf:"varint,13,opt,name=locked,proto3" json:"locked,omitempty"`
	// roles lists the RBAC roles assigned to this user.
	Roles []string `protobuf:"bytes,17,rep,name=roles,proto3" json:"roles,omitempty"`
	// blueprints lists the blueprints the user is permitted to use.
	Blueprints []string `protobuf:"bytes,18,rep,name=blueprints,proto3" json:"blueprints,omitempty"`
	// source identifies the identity provider that created this user (e.g. "github", "ldap").
	Source string `protobuf:"bytes,19,opt,name=source,proto3" json:"source,omitempty"`
	// shell is the user's preferred shell environment (e.g. "bash", "zsh").
	Shell string `protobuf:"bytes,20,opt,name=shell,proto3" json:"shell,omitempty"`
	// sudo indicates whether the user has permission to use sudo in their workspace.
	Sudo bool `protobuf:"varint,21,opt,name=sudo,proto3" json:"sudo,omitempty"`
	// manage_repos is an optional management link to present to the user,
	// e.g. prompting a GitHub user to install the GitHub App.
	ManageRepos string `protobuf:"bytes,22,opt,name=manage_repos,json=manageRepos,proto3" json:"manage_repos,omitempty"`
	// git_address is the address the identity provider has defined for git
	// operations, e.g. "https://github.com".
	GitAddress string `protobuf:"bytes,23,opt,name=git_address,json=gitAddress,proto3" json:"git_address,omitempty"`
	// contains filtered or unexported fields
}

User represents an authenticated k8Shell user account.

func (*User) Descriptor deprecated

func (*User) Descriptor() ([]byte, []int)

Deprecated: Use User.ProtoReflect.Descriptor instead.

func (*User) GetBlueprints

func (x *User) GetBlueprints() []string

func (*User) GetEmail

func (x *User) GetEmail() string

func (*User) GetExpiresAt

func (x *User) GetExpiresAt() *timestamp.Timestamp

func (*User) GetFullname

func (x *User) GetFullname() string

func (*User) GetGid

func (x *User) GetGid() uint32

func (*User) GetGitAddress added in v0.40.0

func (x *User) GetGitAddress() string

func (*User) GetIsValid

func (x *User) GetIsValid() bool

func (*User) GetLocked

func (x *User) GetLocked() bool

func (*User) GetManageRepos added in v0.40.0

func (x *User) GetManageRepos() string

func (*User) GetOrganization

func (x *User) GetOrganization() string

func (*User) GetPassword

func (x *User) GetPassword() string

func (*User) GetRoles

func (x *User) GetRoles() []string

func (*User) GetShell

func (x *User) GetShell() string

func (*User) GetSource

func (x *User) GetSource() string

func (*User) GetSudo

func (x *User) GetSudo() bool

func (*User) GetUid

func (x *User) GetUid() uint32

func (*User) GetUsername

func (x *User) GetUsername() string

func (*User) ProtoMessage

func (*User) ProtoMessage()

func (*User) ProtoReflect

func (x *User) ProtoReflect() protoreflect.Message

func (*User) Reset

func (x *User) Reset()

func (*User) String

func (x *User) String() string

type UserCredential

type UserCredential struct {

	// id is the internal database identifier for this credential.
	Id uint32 `protobuf:"varint,1,opt,name=id,proto3" json:"id,omitempty"`
	// username is the k8Shell user that owns this credential.
	Username string `protobuf:"bytes,2,opt,name=username,proto3" json:"username,omitempty"`
	// service_name identifies the type of service (e.g. "registry", "git", "kubernetes").
	ServiceName string `protobuf:"bytes,3,opt,name=service_name,json=serviceName,proto3" json:"service_name,omitempty"`
	// service_scope is the registry/host URL or Kubernetes namespace
	ServiceScope string `protobuf:"bytes,4,opt,name=service_scope,json=serviceScope,proto3" json:"service_scope,omitempty"`
	// credential_source identifies how the credential was provisioned (e.g. "oauth", "manual", "dynamic").
	CredentialSource string `protobuf:"bytes,11,opt,name=credential_source,json=credentialSource,proto3" json:"credential_source,omitempty"`
	// subject is the login name or service account name
	Subject string `protobuf:"bytes,5,opt,name=subject,proto3" json:"subject,omitempty"`
	// secret is the stored credential (OAuth token, API key, password)
	Secret string `protobuf:"bytes,6,opt,name=secret,proto3" json:"secret,omitempty"`
	// is_active indicates whether this credential is currently active.
	IsActive bool `protobuf:"varint,7,opt,name=is_active,json=isActive,proto3" json:"is_active,omitempty"`
	// created_at is the time the credential was created.
	CreatedAt *timestamp.Timestamp `protobuf:"bytes,8,opt,name=created_at,json=createdAt,proto3" json:"created_at,omitempty"`
	// updated_at is the time the credential was last updated.
	UpdatedAt *timestamp.Timestamp `protobuf:"bytes,9,opt,name=updated_at,json=updatedAt,proto3" json:"updated_at,omitempty"`
	// expires_at is the time at which the secret expires, if known.
	ExpiresAt *timestamp.Timestamp `protobuf:"bytes,10,opt,name=expires_at,json=expiresAt,proto3" json:"expires_at,omitempty"`
	// last_used_at is the time the credential's secret was last resolved for use.
	LastUsedAt *timestamp.Timestamp `protobuf:"bytes,12,opt,name=last_used_at,json=lastUsedAt,proto3" json:"last_used_at,omitempty"`
	// contains filtered or unexported fields
}

UserCredential stores a token or credential issued by an external service on behalf of a user (e.g. a GitHub OAuth token).

func (*UserCredential) Descriptor deprecated

func (*UserCredential) Descriptor() ([]byte, []int)

Deprecated: Use UserCredential.ProtoReflect.Descriptor instead.

func (*UserCredential) GetCreatedAt

func (x *UserCredential) GetCreatedAt() *timestamp.Timestamp

func (*UserCredential) GetCredentialSource

func (x *UserCredential) GetCredentialSource() string

func (*UserCredential) GetExpiresAt

func (x *UserCredential) GetExpiresAt() *timestamp.Timestamp

func (*UserCredential) GetId

func (x *UserCredential) GetId() uint32

func (*UserCredential) GetIsActive

func (x *UserCredential) GetIsActive() bool

func (*UserCredential) GetLastUsedAt added in v0.35.0

func (x *UserCredential) GetLastUsedAt() *timestamp.Timestamp

func (*UserCredential) GetSecret

func (x *UserCredential) GetSecret() string

func (*UserCredential) GetServiceName

func (x *UserCredential) GetServiceName() string

func (*UserCredential) GetServiceScope

func (x *UserCredential) GetServiceScope() string

func (*UserCredential) GetSubject

func (x *UserCredential) GetSubject() string

func (*UserCredential) GetUpdatedAt

func (x *UserCredential) GetUpdatedAt() *timestamp.Timestamp

func (*UserCredential) GetUsername

func (x *UserCredential) GetUsername() string

func (*UserCredential) ProtoMessage

func (*UserCredential) ProtoMessage()

func (*UserCredential) ProtoReflect

func (x *UserCredential) ProtoReflect() protoreflect.Message

func (*UserCredential) Reset

func (x *UserCredential) Reset()

func (*UserCredential) String

func (x *UserCredential) String() string

type UserOnboardCapability

type UserOnboardCapability struct {

	// provider is the OAuth/OIDC provider being queried.
	Provider string `protobuf:"bytes,1,opt,name=provider,proto3" json:"provider,omitempty"`
	// username is the user being checked.
	Username string `protobuf:"bytes,2,opt,name=username,proto3" json:"username,omitempty"`
	// can_onboard is true when the user is eligible to onboard via this provider.
	CanOnboard bool `protobuf:"varint,3,opt,name=can_onboard,json=canOnboard,proto3" json:"can_onboard,omitempty"`
	// contains filtered or unexported fields
}

UserOnboardCapability reports whether a user can be onboarded via a specific provider.

func (*UserOnboardCapability) Descriptor deprecated

func (*UserOnboardCapability) Descriptor() ([]byte, []int)

Deprecated: Use UserOnboardCapability.ProtoReflect.Descriptor instead.

func (*UserOnboardCapability) GetCanOnboard

func (x *UserOnboardCapability) GetCanOnboard() bool

func (*UserOnboardCapability) GetProvider

func (x *UserOnboardCapability) GetProvider() string

func (*UserOnboardCapability) GetUsername

func (x *UserOnboardCapability) GetUsername() string

func (*UserOnboardCapability) ProtoMessage

func (*UserOnboardCapability) ProtoMessage()

func (*UserOnboardCapability) ProtoReflect

func (x *UserOnboardCapability) ProtoReflect() protoreflect.Message

func (*UserOnboardCapability) Reset

func (x *UserOnboardCapability) Reset()

func (*UserOnboardCapability) String

func (x *UserOnboardCapability) String() string

type UserResult added in v0.40.0

type UserResult struct {
	OnboardRule *OnboardUserRule `protobuf:"bytes,1,opt,name=onboard_rule,json=onboardRule,proto3" json:"onboard_rule,omitempty"`
	// manage_repos is a link the client should present to the user for
	// managing their repository access on the provider, e.g. prompting a
	// GitHub user to install the GitHub App now that they've authorized it.
	// Empty when the provider has no such link.
	ManageRepos string `protobuf:"bytes,2,opt,name=manage_repos,json=manageRepos,proto3" json:"manage_repos,omitempty"`
	// git_address is the address the identity provider has defined for git
	// operations, e.g. "https://github.com".
	GitAddress string `protobuf:"bytes,3,opt,name=git_address,json=gitAddress,proto3" json:"git_address,omitempty"`
	// contains filtered or unexported fields
}

UserResult carries an identity provider's onboarding decision for a user — returned by FindUser (re-evaluated for an already-onboarded user) and by CompleteUserWebFlow (evaluated for a user who just completed a provider's web onboarding flow) — plus a repo management link for the client to present and the provider's git address.

func (*UserResult) Descriptor deprecated added in v0.40.0

func (*UserResult) Descriptor() ([]byte, []int)

Deprecated: Use UserResult.ProtoReflect.Descriptor instead.

func (*UserResult) GetGitAddress added in v0.40.0

func (x *UserResult) GetGitAddress() string

func (*UserResult) GetManageRepos added in v0.40.0

func (x *UserResult) GetManageRepos() string

func (*UserResult) GetOnboardRule added in v0.40.0

func (x *UserResult) GetOnboardRule() *OnboardUserRule

func (*UserResult) ProtoMessage added in v0.40.0

func (*UserResult) ProtoMessage()

func (*UserResult) ProtoReflect added in v0.40.0

func (x *UserResult) ProtoReflect() protoreflect.Message

func (*UserResult) Reset added in v0.40.0

func (x *UserResult) Reset()

func (*UserResult) String added in v0.40.0

func (x *UserResult) String() string

type WorkspaceDetails

type WorkspaceDetails struct {

	// workspace_status holds the observed workspace status.
	WorkspaceStatus *WorkspaceStatus `protobuf:"bytes,1,opt,name=workspace_status,json=workspaceStatus,proto3" json:"workspace_status,omitempty"`
	// app_version is the version of the workspace application image in use.
	AppVersion string `protobuf:"bytes,2,opt,name=app_version,json=appVersion,proto3" json:"app_version,omitempty"`
	// name is the unique name of the workspace.
	Name string `protobuf:"bytes,3,opt,name=name,proto3" json:"name,omitempty"`
	// username is the owner of this workspace.
	Username string `protobuf:"bytes,4,opt,name=username,proto3" json:"username,omitempty"`
	// organization is the tenant that owns this workspace.
	Organization string `protobuf:"bytes,5,opt,name=organization,proto3" json:"organization,omitempty"`
	// repo_owner is the VCS owner of the repository attached to this workspace.
	RepoOwner string `protobuf:"bytes,6,opt,name=repo_owner,json=repoOwner,proto3" json:"repo_owner,omitempty"`
	// repo_name is the name of the repository attached to this workspace.
	RepoName string `protobuf:"bytes,7,opt,name=repo_name,json=repoName,proto3" json:"repo_name,omitempty"`
	// repo_ref is the branch, tag, or commit SHA the workspace is based on.
	RepoRef string `protobuf:"bytes,8,opt,name=repo_ref,json=repoRef,proto3" json:"repo_ref,omitempty"`
	// blueprint is the name of the blueprint used to provision this workspace.
	Blueprint string `protobuf:"bytes,9,opt,name=blueprint,proto3" json:"blueprint,omitempty"`
	// server_name is the k8Shell server node this workspace is scheduled on.
	ServerName string `protobuf:"bytes,10,opt,name=server_name,json=serverName,proto3" json:"server_name,omitempty"`
	// pod_ip is the cluster-internal IP address of the workspace pod.
	PodIp string `protobuf:"bytes,11,opt,name=pod_ip,json=podIp,proto3" json:"pod_ip,omitempty"`
	// port is the port on which the workspace IDE or application is listening.
	Port int32 `protobuf:"varint,12,opt,name=port,proto3" json:"port,omitempty"`
	// tls_enabled indicates whether TLS is enabled for the workspace endpoint.
	TlsEnabled bool `protobuf:"varint,13,opt,name=tls_enabled,json=tlsEnabled,proto3" json:"tls_enabled,omitempty"`
	// network_policy_class is the predefined network policy class the workspace
	// pod belongs to: one of "workspace", "system", "isolated", "user",
	// "organization". Empty when the workspace has no network policy class.
	NetworkPolicyClass string `protobuf:"bytes,14,opt,name=network_policy_class,json=networkPolicyClass,proto3" json:"network_policy_class,omitempty"`
	// cpu is the CPU resource allocation in Kubernetes quantity format (e.g. "500m").
	Cpu string `protobuf:"bytes,15,opt,name=cpu,proto3" json:"cpu,omitempty"`
	// memory is the memory resource allocation in Kubernetes quantity format (e.g. "1Gi").
	Memory string `protobuf:"bytes,16,opt,name=memory,proto3" json:"memory,omitempty"`
	// hostname is the externally reachable hostname of the workspace.
	Hostname string `protobuf:"bytes,17,opt,name=hostname,proto3" json:"hostname,omitempty"`
	// job_id is the identifier of the provisioning job that created this workspace.
	JobId string `protobuf:"bytes,18,opt,name=job_id,json=jobId,proto3" json:"job_id,omitempty"`
	// namespace is the Kubernetes namespace in which the workspace pod is running.
	Namespace string `protobuf:"bytes,19,opt,name=namespace,proto3" json:"namespace,omitempty"`
	// origin identifies where the workspace's content came from: "repo_owner/repo_name"
	// when both are set, otherwise the blueprint name.
	Origin string `protobuf:"bytes,20,opt,name=origin,proto3" json:"origin,omitempty"`
	// workspace_type is how the workspace is deployed: "standalone" for a
	// workspace running as its own Helm release, "injected" for one injected
	// into an existing workload.
	WorkspaceType string `protobuf:"bytes,21,opt,name=workspace_type,json=workspaceType,proto3" json:"workspace_type,omitempty"`
	// workload_kind is the Kubernetes kind of the workload the workspace was
	// injected into: "deployment", "statefulset", or "daemonset". Set only when
	// workspace_type is "injected".
	WorkloadKind string `protobuf:"bytes,22,opt,name=workload_kind,json=workloadKind,proto3" json:"workload_kind,omitempty"`
	// workload_name is the name of the workload the workspace was injected
	// into. Set only when workspace_type is "injected".
	WorkloadName string `protobuf:"bytes,23,opt,name=workload_name,json=workloadName,proto3" json:"workload_name,omitempty"`
	// replica_index is which replica of the workload this workspace is. For a
	// StatefulSet it is the pod's ordinal and is stable. For a Deployment it is
	// the pod's position among its siblings ordered by pod name, and for a
	// DaemonSet its position ordered by node name; a Deployment index therefore
	// shifts when pods are replaced. Set only when workspace_type is "injected".
	ReplicaIndex *int32 `protobuf:"varint,24,opt,name=replica_index,json=replicaIndex,proto3,oneof" json:"replica_index,omitempty"`
	// replica_count is the workload's desired replica count: spec.replicas for a
	// Deployment or StatefulSet, status.desiredNumberScheduled for a DaemonSet.
	// Set only when workspace_type is "injected".
	ReplicaCount *int32 `protobuf:"varint,25,opt,name=replica_count,json=replicaCount,proto3,oneof" json:"replica_count,omitempty"`
	// allow_egress_to_cidrs is the set of CIDR egress shortcuts in force on the
	// workspace pod. It reports the settings live on the pod now, which a call to
	// UpdateWorkspaceResources can change and which revert to the blueprint on
	// the next re-provision.
	AllowEgressToCidrs []string `protobuf:"bytes,26,rep,name=allow_egress_to_cidrs,json=allowEgressToCidrs,proto3" json:"allow_egress_to_cidrs,omitempty"`
	// allow_egress_to_pods is the set of pod-label egress shortcuts in force on
	// the workspace pod, with the same live-view and revert semantics as
	// allow_egress_to_cidrs.
	AllowEgressToPods []*PodLabelSelector `protobuf:"bytes,27,rep,name=allow_egress_to_pods,json=allowEgressToPods,proto3" json:"allow_egress_to_pods,omitempty"`
	// web_proxy_port is the in-workspace TCP port currently published through the
	// web proxy. It reports the route live on the pod now, which a call to
	// UpdateWorkspaceResources can change and which reverts to the blueprint on
	// the next re-provision. 0 when the workspace publishes no route, and for an
	// injected workspace.
	WebProxyPort int32 `protobuf:"varint,28,opt,name=web_proxy_port,json=webProxyPort,proto3" json:"web_proxy_port,omitempty"`
	// web_proxy_roles is the set of user roles allowed to reach the web-proxy
	// route, with the same live-view and revert semantics as web_proxy_port.
	// Empty when the workspace publishes no route, and for an injected workspace.
	WebProxyRoles []string `protobuf:"bytes,29,rep,name=web_proxy_roles,json=webProxyRoles,proto3" json:"web_proxy_roles,omitempty"`
	// web_proxy_alias is the alias the web-proxy route is reachable under,
	// unique within the organization, with the same live-view and revert
	// semantics as web_proxy_port. Empty when no alias is applied.
	WebProxyAlias string `protobuf:"bytes,30,opt,name=web_proxy_alias,json=webProxyAlias,proto3" json:"web_proxy_alias,omitempty"`
	// web_proxy_alias_message explains why the blueprint's alias was not
	// applied, e.g. because another workspace of the organization holds it.
	// Empty when the alias was applied or the blueprint declares none.
	WebProxyAliasMessage string `` /* 126-byte string literal not displayed */
	// blueprint_revision is the content revision of the blueprint the
	// workspace was provisioned from (see BlueprintSummary.revision). Empty
	// for a workspace provisioned before revisions were recorded.
	BlueprintRevision string `protobuf:"bytes,32,opt,name=blueprint_revision,json=blueprintRevision,proto3" json:"blueprint_revision,omitempty"`
	// blueprint_outdated reports whether the blueprint's current revision
	// differs from blueprint_revision, i.e. whether a re-provision would change
	// the workspace's blueprint. Unset when that cannot be determined: no
	// recorded revision, the blueprint no longer exists, or the workspace was
	// built from a repository's k8shell file, whose current content the
	// provisioner does not track.
	BlueprintOutdated *bool `protobuf:"varint,33,opt,name=blueprint_outdated,json=blueprintOutdated,proto3,oneof" json:"blueprint_outdated,omitempty"`
	// contains filtered or unexported fields
}

WorkspaceDetails describes a user workspace and its current runtime state.

func (*WorkspaceDetails) Descriptor deprecated

func (*WorkspaceDetails) Descriptor() ([]byte, []int)

Deprecated: Use WorkspaceDetails.ProtoReflect.Descriptor instead.

func (*WorkspaceDetails) GetAllowEgressToCidrs added in v0.49.0

func (x *WorkspaceDetails) GetAllowEgressToCidrs() []string

func (*WorkspaceDetails) GetAllowEgressToPods added in v0.49.0

func (x *WorkspaceDetails) GetAllowEgressToPods() []*PodLabelSelector

func (*WorkspaceDetails) GetAppVersion

func (x *WorkspaceDetails) GetAppVersion() string

func (*WorkspaceDetails) GetBlueprint

func (x *WorkspaceDetails) GetBlueprint() string

func (*WorkspaceDetails) GetBlueprintOutdated added in v0.63.7

func (x *WorkspaceDetails) GetBlueprintOutdated() bool

func (*WorkspaceDetails) GetBlueprintRevision added in v0.63.7

func (x *WorkspaceDetails) GetBlueprintRevision() string

func (*WorkspaceDetails) GetCpu

func (x *WorkspaceDetails) GetCpu() string

func (*WorkspaceDetails) GetHostname

func (x *WorkspaceDetails) GetHostname() string

func (*WorkspaceDetails) GetJobId

func (x *WorkspaceDetails) GetJobId() string

func (*WorkspaceDetails) GetMemory

func (x *WorkspaceDetails) GetMemory() string

func (*WorkspaceDetails) GetName

func (x *WorkspaceDetails) GetName() string

func (*WorkspaceDetails) GetNamespace

func (x *WorkspaceDetails) GetNamespace() string

func (*WorkspaceDetails) GetNetworkPolicyClass added in v0.49.0

func (x *WorkspaceDetails) GetNetworkPolicyClass() string

func (*WorkspaceDetails) GetOrganization

func (x *WorkspaceDetails) GetOrganization() string

func (*WorkspaceDetails) GetOrigin added in v0.36.0

func (x *WorkspaceDetails) GetOrigin() string

func (*WorkspaceDetails) GetPodIp

func (x *WorkspaceDetails) GetPodIp() string

func (*WorkspaceDetails) GetPort

func (x *WorkspaceDetails) GetPort() int32

func (*WorkspaceDetails) GetReplicaCount added in v0.38.0

func (x *WorkspaceDetails) GetReplicaCount() int32

func (*WorkspaceDetails) GetReplicaIndex added in v0.38.0

func (x *WorkspaceDetails) GetReplicaIndex() int32

func (*WorkspaceDetails) GetRepoName

func (x *WorkspaceDetails) GetRepoName() string

func (*WorkspaceDetails) GetRepoOwner

func (x *WorkspaceDetails) GetRepoOwner() string

func (*WorkspaceDetails) GetRepoRef

func (x *WorkspaceDetails) GetRepoRef() string

func (*WorkspaceDetails) GetServerName

func (x *WorkspaceDetails) GetServerName() string

func (*WorkspaceDetails) GetTlsEnabled

func (x *WorkspaceDetails) GetTlsEnabled() bool

func (*WorkspaceDetails) GetUsername

func (x *WorkspaceDetails) GetUsername() string

func (*WorkspaceDetails) GetWebProxyAlias added in v0.62.2

func (x *WorkspaceDetails) GetWebProxyAlias() string

func (*WorkspaceDetails) GetWebProxyAliasMessage added in v0.62.2

func (x *WorkspaceDetails) GetWebProxyAliasMessage() string

func (*WorkspaceDetails) GetWebProxyPort added in v0.50.0

func (x *WorkspaceDetails) GetWebProxyPort() int32

func (*WorkspaceDetails) GetWebProxyRoles added in v0.50.0

func (x *WorkspaceDetails) GetWebProxyRoles() []string

func (*WorkspaceDetails) GetWorkloadKind added in v0.38.0

func (x *WorkspaceDetails) GetWorkloadKind() string

func (*WorkspaceDetails) GetWorkloadName added in v0.38.0

func (x *WorkspaceDetails) GetWorkloadName() string

func (*WorkspaceDetails) GetWorkspaceStatus

func (x *WorkspaceDetails) GetWorkspaceStatus() *WorkspaceStatus

func (*WorkspaceDetails) GetWorkspaceType added in v0.38.0

func (x *WorkspaceDetails) GetWorkspaceType() string

func (*WorkspaceDetails) ProtoMessage

func (*WorkspaceDetails) ProtoMessage()

func (*WorkspaceDetails) ProtoReflect

func (x *WorkspaceDetails) ProtoReflect() protoreflect.Message

func (*WorkspaceDetails) Reset

func (x *WorkspaceDetails) Reset()

func (*WorkspaceDetails) String

func (x *WorkspaceDetails) String() string

type WorkspaceStatus

type WorkspaceStatus struct {

	// created is the time the workspace was created.
	Created *timestamp.Timestamp `protobuf:"bytes,1,opt,name=created,proto3" json:"created,omitempty"`
	// status is the current workspace status (e.g. "Starting", "Running", "Failing").
	Status string `protobuf:"bytes,2,opt,name=status,proto3" json:"status,omitempty"`
	// message provides additional human-readable detail about the current status.
	Message string `protobuf:"bytes,3,opt,name=message,proto3" json:"message,omitempty"`
	// restarts is the number of times the pod's primary container has restarted.
	Restarts int32 `protobuf:"varint,4,opt,name=restarts,proto3" json:"restarts,omitempty"`
	// last_fail_message is the termination message from the last container failure,
	// if any.
	LastFailMessage string `protobuf:"bytes,5,opt,name=last_fail_message,json=lastFailMessage,proto3" json:"last_fail_message,omitempty"`
	// contains filtered or unexported fields
}

WorkspaceStatus represents the observed status of a workspace.

func (*WorkspaceStatus) Descriptor deprecated

func (*WorkspaceStatus) Descriptor() ([]byte, []int)

Deprecated: Use WorkspaceStatus.ProtoReflect.Descriptor instead.

func (*WorkspaceStatus) GetCreated

func (x *WorkspaceStatus) GetCreated() *timestamp.Timestamp

func (*WorkspaceStatus) GetLastFailMessage

func (x *WorkspaceStatus) GetLastFailMessage() string

func (*WorkspaceStatus) GetMessage

func (x *WorkspaceStatus) GetMessage() string

func (*WorkspaceStatus) GetRestarts

func (x *WorkspaceStatus) GetRestarts() int32

func (*WorkspaceStatus) GetStatus

func (x *WorkspaceStatus) GetStatus() string

func (*WorkspaceStatus) ProtoMessage

func (*WorkspaceStatus) ProtoMessage()

func (*WorkspaceStatus) ProtoReflect

func (x *WorkspaceStatus) ProtoReflect() protoreflect.Message

func (*WorkspaceStatus) Reset

func (x *WorkspaceStatus) Reset()

func (*WorkspaceStatus) String

func (x *WorkspaceStatus) String() string

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL