server

package
v0.78.0 Latest Latest
Warning

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

Go to latest
Published: Dec 22, 2025 License: Apache-2.0 Imports: 79 Imported by: 0

README

admin/server

GitHub Connection

State Parameter in GitHub Authentication

When integrating with GitHub, installation request for our github app utilize a "state" parameter that is passed to GitHub and returned during the callback process. This mechanism helps maintain context across the OAuth flow.

For GitHub Installation Requests

The state parameter contains a JSON object with two key components:

  1. Repository Association: repo field is used to store the specific repo associated with the original installation request from either the cli or UI. This is used to verify that the installation succeeded.

  2. UI Redirection: redirect field is used to store the redirect url sent in the original installation request. This is mainly used by UI based deploy in rill developer to continue deploy process in the browser.

For GitHub Authentication-Only Requests

For authentication-only requests (without installation):

  • The same two values are stored in the user's session
  • These values are retrieved during the callback process
  • This approach maintains context across the authentication flow

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Options added in v0.23.0

type Options struct {
	HTTPPort               int
	GRPCPort               int
	AllowedOrigins         []string
	SessionKeyPairs        [][]byte
	ServePrometheus        bool
	AuthDomain             string
	AuthClientID           string
	AuthClientSecret       string
	GithubAppName          string
	GithubAppWebhookSecret string
	GithubClientID         string
	GithubClientSecret     string
	GithubManagedAccount   string
	// AssetsBucket is the path on gcs where rill managed project artifacts are stored.
	AssetsBucket string
}

type Server

type Server struct {
	adminv1.UnsafeAdminServiceServer
	adminv1.UnsafeAIServiceServer
	adminv1.UnsafeTelemetryServiceServer
	// contains filtered or unexported fields
}

func New

func New(logger *zap.Logger, adm *admin.Service, issuer *runtimeauth.Issuer, limiter ratelimit.Limiter, activityClient *activity.Client, opts *Options) (*Server, error)

func (*Server) AddOrganizationMemberUser added in v0.47.2

func (*Server) AddOrganizationMemberUsergroup added in v0.47.2

func (*Server) AddProjectMemberUser added in v0.47.2

func (*Server) AddProjectMemberUsergroup added in v0.47.2

func (*Server) AddUsergroupMemberUser added in v0.47.2

func (*Server) ApproveProjectAccess added in v0.48.0

func (*Server) AwaitServing added in v0.58.0

func (s *Server) AwaitServing(ctx context.Context) error

AwaitServing waits for both the HTTP and gRPC servers to be reachable on their localhost ports.

func (*Server) CancelBillingSubscription added in v0.50.0

CancelBillingSubscription cancels the billing subscription for the organization

func (*Server) Complete added in v0.41.0

func (*Server) ConnectProjectToGithub added in v0.48.0

func (*Server) CreateAlert added in v0.41.0

func (*Server) CreateAsset added in v0.47.0

func (*Server) CreateBookmark added in v0.30.0

CreateBookmark server creates a bookmark for the user per project

func (*Server) CreateDeployment added in v0.78.0

CreateDeployment creates a new deployment for a project.

func (*Server) CreateManagedGitRepo added in v0.62.0

func (*Server) CreateProject

func (*Server) CreateProjectWhitelistedDomain added in v0.44.0

func (*Server) CreateReport added in v0.37.0

func (*Server) CreateService added in v0.31.0

CreateService creates a new service account.

func (*Server) CreateUsergroup added in v0.47.2

func (*Server) CreateWhitelistedDomain added in v0.27.0

func (*Server) DeleteAlert added in v0.41.0

func (*Server) DeleteDeployment added in v0.78.0

DeleteDeployment deletes a deployment by ID.

func (*Server) DeleteProject

func (*Server) DeleteReport added in v0.37.0

func (*Server) DeleteService added in v0.31.0

DeleteService deletes a service account.

func (*Server) DeleteUser added in v0.56.0

func (*Server) DeleteUsergroup added in v0.47.2

func (*Server) DeleteVirtualFile added in v0.78.0

func (*Server) DenyProjectAccess added in v0.48.0

func (*Server) EditAlert added in v0.41.0

func (*Server) EditReport added in v0.37.0

func (*Server) EditUsergroup added in v0.47.2

func (*Server) GenerateAlertYAML added in v0.41.0

func (*Server) GenerateReportYAML added in v0.37.0

func (*Server) GetAlertMeta added in v0.41.0

func (*Server) GetAlertYAML added in v0.41.0

func (*Server) GetBillingProjectCredentials added in v0.51.0

func (*Server) GetBillingSubscription added in v0.48.0

func (*Server) GetBookmark added in v0.30.0

GetBookmark server returns the bookmark for the user per project

func (*Server) GetCloneCredentials added in v0.47.0

func (*Server) GetCurrentMagicAuthToken added in v0.48.0

func (*Server) GetCurrentUser added in v0.23.0

func (*Server) GetDeployment added in v0.78.0

GetDeployment returns runtime info and JWT on behalf of a specific user, or alternatively for a raw set of JWT attributes

func (*Server) GetDeploymentCredentials added in v0.33.2

GetDeploymentCredentials returns runtime info and JWT on behalf of a specific user, or alternatively for a raw set of JWT attributes

func (*Server) GetGithubRepoStatus added in v0.23.0

func (*Server) GetGithubUserStatus added in v0.43.0

func (*Server) GetIFrame added in v0.38.0

func (*Server) GetOrganization added in v0.23.0

func (*Server) GetOrganizationMemberUser added in v0.78.0

func (*Server) GetOrganizationNameForDomain added in v0.49.0

func (*Server) GetPaymentsPortalURL added in v0.48.0

func (*Server) GetProject added in v0.23.0

func (*Server) GetProjectAccessRequest added in v0.48.0

func (*Server) GetProjectByID added in v0.47.0

func (*Server) GetProjectVariables added in v0.24.0

func (*Server) GetRepoMeta added in v0.37.0

func (*Server) GetReportMeta added in v0.37.0

func (*Server) GetService added in v0.78.0

func (*Server) GetUser added in v0.28.2

func (*Server) GetUsergroup added in v0.47.2

func (*Server) GetVirtualFile added in v0.78.0

func (*Server) HTTPHandler added in v0.21.1

func (s *Server) HTTPHandler(ctx context.Context) (http.Handler, error)

HTTPHandler returns a HTTP handler that serves REST and gRPC.

func (*Server) HibernateProject added in v0.47.4

func (*Server) IssueMagicAuthToken added in v0.47.0

func (*Server) IssueRepresentativeAuthToken added in v0.27.0

IssueRepresentativeAuthToken returns the temporary auth token for representing email

func (*Server) IssueServiceAuthToken added in v0.31.0

IssueServiceAuthToken issues a new auth token for a service account.

func (*Server) IssueUserAuthToken added in v0.64.1

func (*Server) LeaveOrganization added in v0.24.0

func (*Server) ListBookmarks added in v0.30.0

ListBookmarks server returns the bookmarks for the user per project

func (*Server) ListDeployments added in v0.78.0

ListDeployments returns a list of deployments for a given project.

func (*Server) ListGithubUserRepos added in v0.48.0

func (*Server) ListMagicAuthTokens added in v0.47.0

func (*Server) ListOrganizationBillingIssues added in v0.50.0

func (*Server) ListOrganizationInvites added in v0.24.4

func (*Server) ListOrganizationMemberUsers added in v0.47.2

func (*Server) ListOrganizations added in v0.23.0

func (*Server) ListProjectInvites added in v0.24.4

func (*Server) ListProjectMemberServices added in v0.78.0

ListProjectMemberServices lists all service accounts for a project.

func (*Server) ListProjectMemberUsergroups added in v0.47.2

func (*Server) ListProjectMemberUsers added in v0.47.2

func (*Server) ListProjectWhitelistedDomains added in v0.44.0

func (*Server) ListProjectsForFingerprint added in v0.78.0

func (*Server) ListProjectsForOrganization added in v0.24.0

func (*Server) ListProjectsForUserByName added in v0.62.0

func (*Server) ListPublicBillingPlans added in v0.47.0

func (*Server) ListRoles added in v0.58.0

func (*Server) ListServiceAuthTokens added in v0.31.0

ListServiceAuthTokens lists all auth tokens for a service account.

func (*Server) ListServices added in v0.31.0

ListServices lists all service accounts in an organization.

func (*Server) ListSuperusers added in v0.26.0

func (*Server) ListUserAuthTokens added in v0.64.1

func (*Server) ListUsergroupMemberUsers added in v0.47.2

func (*Server) ListWhitelistedDomains added in v0.27.0

func (*Server) Ping added in v0.21.1

Ping implements AdminService

func (*Server) Provision added in v0.53.0

func (*Server) PullVirtualRepo added in v0.37.0

func (*Server) RecordEvents added in v0.42.0

func (*Server) RedeployProject added in v0.49.0

func (*Server) RemoveBookmark added in v0.30.0

RemoveBookmark server removes a bookmark for bookmark id

func (*Server) RemoveOrganizationMemberService added in v0.78.0

func (*Server) RemoveOrganizationMemberUser added in v0.47.2

func (*Server) RemoveProjectMemberService added in v0.78.0

func (*Server) RemoveProjectMemberUser added in v0.47.2

func (*Server) RemoveProjectMemberUsergroup added in v0.47.2

func (*Server) RemoveProjectWhitelistedDomain added in v0.44.0

func (*Server) RemoveUsergroupMemberUser added in v0.47.2

func (*Server) RemoveWhitelistedDomain added in v0.27.0

func (*Server) RenameUsergroup added in v0.47.2

func (*Server) RenewBillingSubscription added in v0.50.0

func (*Server) RequestProjectAccess added in v0.48.0

func (*Server) RevokeAllUserAuthTokens added in v0.78.0

func (*Server) RevokeCurrentAuthToken added in v0.23.0

RevokeCurrentAuthToken revokes the current auth token

func (*Server) RevokeMagicAuthToken added in v0.47.0

func (*Server) RevokeRepresentativeAuthTokens added in v0.78.0

func (*Server) RevokeServiceAuthToken added in v0.31.0

RevokServiceAuthToken revokes an auth token for a service account.

func (*Server) RevokeUserAuthToken added in v0.64.1

func (*Server) SearchProjectNames added in v0.29.0

func (*Server) SearchProjectUsers added in v0.33.2

SearchProjectUsers returns a list of users that match the given search/email query.

func (*Server) SearchUsers added in v0.27.0

func (*Server) ServeHTTP added in v0.21.1

func (s *Server) ServeHTTP(ctx context.Context) error

Starts the HTTP server.

func (*Server) SetOrganizationMemberUserRole added in v0.47.2

func (*Server) SetProjectMemberServiceRole added in v0.78.0

func (*Server) SetProjectMemberUserRole added in v0.47.2

func (*Server) SetProjectMemberUsergroupRole added in v0.47.2

func (*Server) SetSuperuser added in v0.26.0

func (*Server) StartDeployment added in v0.78.0

StartDeployment starts a deployment by ID.

func (*Server) StopDeployment added in v0.78.0

StopDeployment stops a deployment by ID.

func (*Server) SudoExtendTrial added in v0.51.0

func (*Server) SudoGetResource added in v0.27.3

func (*Server) SudoIssueRuntimeManagerToken added in v0.47.5

func (*Server) SudoTriggerBillingRepair added in v0.51.0

func (*Server) SudoUpdateAnnotations added in v0.40.0

SudoUpdateTags updates the tags for a project in organization for superusers

func (*Server) SudoUpdateOrganizationBillingCustomer added in v0.47.0

SudoUpdateOrganizationBillingCustomer updates the billing customer id for an organization. May be useful if customer is initialized manually in billing system

func (*Server) SudoUpdateOrganizationQuotas added in v0.28.2

func (*Server) SudoUpdateUserQuotas added in v0.28.2

func (*Server) TriggerReconcile deprecated added in v0.24.3

Deprecated: See details in api.proto.

func (*Server) TriggerRedeploy deprecated added in v0.24.3

Deprecated: See api.proto for details.

func (*Server) TriggerRefreshSources deprecated added in v0.24.3

Deprecated: See details in api.proto.

func (*Server) TriggerReport added in v0.37.0

func (*Server) UnsubscribeAlert added in v0.41.0

func (*Server) UnsubscribeReport added in v0.37.0

func (*Server) UpdateBillingSubscription added in v0.48.0

func (*Server) UpdateBookmark added in v0.42.0

UpdateBookmark updates a bookmark for the given user for the given project

func (*Server) UpdateProject

func (*Server) UpdateProjectVariables added in v0.24.0

func (*Server) UpdateService added in v0.31.0

UpdateService updates a service account.

func (*Server) UpdateUserPreferences added in v0.30.0

type WebOpenMode added in v0.58.0

type WebOpenMode string
const (
	WebOpenModeRecipient WebOpenMode = "recipient"
	WebOpenModeCreator   WebOpenMode = "creator"
	WebOpenModeNone      WebOpenMode = "none"
)

func (WebOpenMode) Valid added in v0.58.0

func (m WebOpenMode) Valid() bool

Directories

Path Synopsis

Jump to

Keyboard shortcuts

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