server

package
v0.11.2 Latest Latest
Warning

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

 Go to latest Published: Feb 24, 2025 License: Apache-2.0 Imports: 76 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	VARY_HEADER = "Vary"
	DRY_RUN_ARG = "dryRun"
	PROMOTE_ARG = "promote"
	SERVER_NAME = "Clace"
)
View Source 
const (
	DEFAULT_CERT_FILE = "default.crt"
	DEFAULT_KEY_FILE  = "default.key"
	APPSPECS          = "appspecs"
)
View Source 
const (
	DOCKER_COMMAND = "docker"
	PODMAN_COMMAND = "podman"
)
View Source 
const (
	PROVIDER_NAME_DELIMITER = "_"
	SESSION_COOKIE          = "clace_session"
	AUTH_KEY                = "authenticated"
	USER_ID_KEY             = "user"
	USER_EMAIL_KEY          = "email"
	USER_NICKNAME_KEY       = "nickname"
	PROVIDER_NAME_KEY       = "provider_name"
	REDIRECT_URL            = "redirect"
)
View Source 
const (
	APP = "app"
)
View Source 
const CURRENT_AUDIT_DB_VERSION = 1
View Source 
const (
	REALM = "clace"
)

Variables

View Source 
var CL_HOME = os.ExpandEnv("$CL_HOME")

CL_HOME is the root directory for Clace logs and temp files

View Source 
var (
	COMPRESSION_ENABLED_MIME_TYPES = []string{
		"text/html",
		"text/css",
		"text/plain",
		"text/xml",
		"text/x-component",
		"text/javascript",
		"application/x-javascript",
		"application/javascript",
		"application/json",
		"application/manifest+json",
		"application/vnd.api+json",
		"application/xml",
		"application/xhtml+xml",
		"application/rss+xml",
		"application/atom+xml",
		"application/vnd.ms-fontobject",
		"application/x-font-ttf",
		"application/x-font-opentype",
		"application/x-font-truetype",
		"image/svg+xml",
		"image/x-icon",
		"image/vnd.microsoft.icon",
		"font/ttf",
		"font/eot",
		"font/otf",
		"font/opentype",
	}
)

Functions

func AddVaryHeader 

func AddVaryHeader(next http.Handler) http.Handler

func GenerateSelfSignedCertificate 

func GenerateSelfSignedCertificate(certPath, keyPath string, validityDuration time.Duration) error

func MatchGlob added in v0.10.7 

func MatchGlob(appPathGlob string, app types.AppPathDomain) (bool, error)

func ParseGlob added in v0.7.0 

func ParseGlob(appPathGlob string, apps []types.AppPathDomain) ([]types.AppPathDomain, error)

ParseGlob parses a path spec in the format of domain:path. If domain is not specified, it will match empty domain. glob patters are supported, *:** matches all apps.

func ParseGlobFromInfo added in v0.7.0 

func ParseGlobFromInfo(appPathGlob string, apps []types.AppInfo) ([]types.AppInfo, error)

ParseGlobFromInfo parses a path spec in the format of domain:path. If domain is not specified, it will match empty domain. glob patters are supported, *:** matches all apps.

Types

type AdminBasicAuth 

type AdminBasicAuth struct {
	*types.Logger
	// contains filtered or unexported fields
}

AdminBasicAuth implements basic auth for the admin user account. Cache the success auth header to avoid the bcrypt hash check penalty Basic auth is supported for admin user only, and changing it requires service restart. Caching the sha of the successful auth header allows us to skip the bcrypt check which significantly improves performance.

func NewAdminBasicAuth 

func NewAdminBasicAuth(logger *types.Logger, config *types.ServerConfig) *AdminBasicAuth

func (*AdminBasicAuth) BasicAuth 

func (a *AdminBasicAuth) BasicAuth(authHeader string) (username, password string, ok bool)

type AppStore 

type AppStore struct {
	*types.Logger
	// contains filtered or unexported fields
}

AppStore is a store of apps. List of apps is stored in memory. Apps are initialized lazily, AddApp has to be called before GetApp to initialize the app

func NewAppStore 

func NewAppStore(logger *types.Logger, server *Server) *AppStore

func (*AppStore) AddApp 

func (a *AppStore) AddApp(app *app.App)

func (*AppStore) ClearAllAppCache added in v0.4.5 

func (a *AppStore) ClearAllAppCache()

func (*AppStore) DeleteApps added in v0.3.0 

func (a *AppStore) DeleteApps(pathDomain []types.AppPathDomain)

func (*AppStore) DeleteAppsAudit added in v0.10.2 

func (a *AppStore) DeleteAppsAudit(ctx context.Context, pathDomain []types.AppPathDomain, op string) error

func (*AppStore) DeleteLinkedApps added in v0.3.0 

func (a *AppStore) DeleteLinkedApps(pathDomain types.AppPathDomain) error

func (*AppStore) GetAllAppsInfo added in v0.10.2 

func (a *AppStore) GetAllAppsInfo() ([]types.AppInfo, error)

func (*AppStore) GetAllDomains added in v0.9.0 

func (a *AppStore) GetAllDomains() (map[string]bool, error)

func (*AppStore) GetApp 

func (a *AppStore) GetApp(pathDomain types.AppPathDomain) (*app.App, error)

func (*AppStore) GetAppInfo added in v0.9.0 

func (a *AppStore) GetAppInfo(appId types.AppId) (types.AppInfo, bool)

func (*AppStore) GetAppsFullInfo added in v0.10.2 

func (a *AppStore) GetAppsFullInfo() ([]types.AppInfo, map[string]bool, error)

func (*AppStore) UpdateApps added in v0.3.0 

func (a *AppStore) UpdateApps(apps []*app.App)

type CacheDir added in v0.11.0 

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

type ContextShared added in v0.10.2 

type ContextShared struct {
	UserId    string
	AppId     string
	Operation string
	Target    string
	DryRun    bool
}

type Handler 

type Handler struct {
	*types.Logger
	// contains filtered or unexported fields
}

func NewTCPHandler 

func NewTCPHandler(logger *types.Logger, config *types.ServerConfig, server *Server) *Handler

NewTCPHandler creates a new handler for HTTP/HTTPS requests. App API's are mounted amd authentication is enabled. It also mounts the internal APIs if admin over TCP is enabled

func NewUDSHandler 

func NewUDSHandler(logger *types.Logger, config *types.ServerConfig, server *Server) *Handler

NewUDSHandler creates a new handler for admin APIs over the unix domain socket

type Repo added in v0.11.0 

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

type RepoCache added in v0.11.0 

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

func NewRepoCache added in v0.11.0 

func NewRepoCache(server *Server) (*RepoCache, error)

func (*RepoCache) CheckoutRepo added in v0.11.0 

func (r *RepoCache) CheckoutRepo(sourceUrl, branch, commit, gitAuth string) (string, string, string, string, error)

func (*RepoCache) Cleanup added in v0.11.0 

func (r *RepoCache) Cleanup()

type SSOAuth added in v0.5.0 

type SSOAuth struct {
	*types.Logger
	// contains filtered or unexported fields
}

func NewSSOAuth added in v0.5.0 

func NewSSOAuth(logger *types.Logger, config *types.ServerConfig) *SSOAuth

func (*SSOAuth) CheckAuth added in v0.5.0 

func (s *SSOAuth) CheckAuth(w http.ResponseWriter, r *http.Request, appProvider string, updateRedirect bool) (string, error)

func (*SSOAuth) RegisterRoutes added in v0.5.0 

func (s *SSOAuth) RegisterRoutes(mux *chi.Mux)

func (*SSOAuth) Setup added in v0.5.0 

func (s *SSOAuth) Setup() error

func (*SSOAuth) ValidateAuthType added in v0.5.0 

func (s *SSOAuth) ValidateAuthType(authType string) bool

func (*SSOAuth) ValidateProviderName added in v0.5.0 

func (s *SSOAuth) ValidateProviderName(provider string) bool

type Server 

type Server struct {
	*types.Logger
	// contains filtered or unexported fields
}

Server is the instance of the Clace Server

func NewServer 

func NewServer(config *types.ServerConfig) (*Server, error)

NewServer creates a new instance of the Clace Server

func (*Server) Apply added in v0.10.7 

func (s *Server) Apply(ctx context.Context, applyPath string, appPathGlob string, approve, dryRun, promote bool,
	reload types.AppReloadOption, branch, commit, gitAuth string, force bool) (*types.AppApplyResponse, error)

func (*Server) CheckAppValid added in v0.3.0 

func (s *Server) CheckAppValid(domain, matchPath string) (string, error)

func (*Server) CompleteTransaction added in v0.3.0 

func (s *Server) CompleteTransaction(ctx context.Context, tx types.Transaction, entries []types.AppPathDomain, dryRun bool, op string) error

func (*Server) CreateApp added in v0.2.0 

func (s *Server) CreateApp(ctx context.Context, appPath string,
	approve, dryRun bool, appRequest *types.CreateAppRequest) (*types.AppCreateResponse, error)

func (*Server) CreateAppTx added in v0.11.0 

func (s *Server) CreateAppTx(ctx context.Context, currentTx types.Transaction, appPath string,
	approve, dryRun bool, appRequest *types.CreateAppRequest, repoCache *RepoCache) (*types.AppCreateResponse, error)

func (*Server) DeleteApps added in v0.3.0 

func (s *Server) DeleteApps(ctx context.Context, appPathGlob string, dryRun bool) (*types.AppDeleteResponse, error)

func (*Server) FilterApps added in v0.3.0 

func (s *Server) FilterApps(appappPathGlob string, includeInternal bool) ([]types.AppInfo, error)

func (*Server) GetApp 

func (s *Server) GetApp(pathDomain types.AppPathDomain, init bool) (*app.App, error)

func (*Server) GetAppApi added in v0.4.0 

func (s *Server) GetAppApi(ctx context.Context, appPath string) (*types.AppGetResponse, error)

func (*Server) GetAppEntry added in v0.3.0 

func (s *Server) GetAppEntry(ctx context.Context, tx types.Transaction, pathDomain types.AppPathDomain) (*types.AppEntry, error)

func (*Server) GetAppSpec added in v0.6.0 

func (s *Server) GetAppSpec(name types.AppSpec) types.SpecFiles

func (*Server) GetApps added in v0.3.0 

func (s *Server) GetApps(ctx context.Context, appPathGlob string, internal bool) ([]types.AppResponse, error)

func (*Server) GetListAppsApp added in v0.9.0 

func (s *Server) GetListAppsApp() (*app.App, error)

func (*Server) InsertAuditEvent added in v0.10.2 

func (s *Server) InsertAuditEvent(event *types.AuditEvent) error

func (*Server) MatchApp 

func (s *Server) MatchApp(hostHeader, matchPath string) (types.AppInfo, error)

func (*Server) ParseGlob added in v0.10.2 

func (s *Server) ParseGlob(appGlob string) ([]types.AppInfo, error)

func (*Server) PreviewApp added in v0.3.0 

func (s *Server) PreviewApp(ctx context.Context, mainAppPath, commitId string, approve, dryRun bool) (*types.AppPreviewResponse, error)

func (*Server) PromoteApps added in v0.3.0 

func (s *Server) PromoteApps(ctx context.Context, appPathGlob string, dryRun bool) (*types.AppPromoteResponse, error)

func (*Server) ReloadApp added in v0.11.0 

func (s *Server) ReloadApp(ctx context.Context, tx types.Transaction, appEntry *types.AppEntry, stageAppEntry *types.AppEntry,
	approve, dryRun, promote bool, branch, commit, gitAuth string, repoCache *RepoCache) (*types.AppReloadResult, error)

func (*Server) ReloadApps added in v0.3.0 

func (s *Server) ReloadApps(ctx context.Context, appPathGlob string, approve, dryRun, promote bool, branch, commit, gitAuth string) (*types.AppReloadResponse, error)

func (*Server) StagedUpdate added in v0.4.1 

func (s *Server) StagedUpdate(ctx context.Context, appPathGlob string, dryRun, promote bool, handler stagedUpdateHandler, args map[string]any, op string) (*types.AppStagedUpdateResponse, error)

func (*Server) StagedUpdateAppsTx added in v0.4.1 

func (s *Server) StagedUpdateAppsTx(ctx context.Context, tx types.Transaction, appPathGlob string, promote bool, handler stagedUpdateHandler, args map[string]any) ([]any, []types.AppPathDomain, []types.AppPathDomain, error)

func (*Server) Start 

func (s *Server) Start() error

Start starts the Clace Server

func (*Server) Stop 

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

Stop stops the Clace Server

func (*Server) TokenCreate added in v0.7.0 

func (s *Server) TokenCreate(ctx context.Context, appPath string, webhookType types.WebhookType, dryRun bool) (*types.TokenCreateResponse, error)

func (*Server) TokenDelete added in v0.7.0 

func (s *Server) TokenDelete(ctx context.Context, appPath string, webhookType types.WebhookType, dryRun bool) (*types.TokenDeleteResponse, error)

func (*Server) TokenList added in v0.7.0 

func (s *Server) TokenList(ctx context.Context, appPath string) (*types.TokenListResponse, error)

func (*Server) UpdateAppSettings added in v0.3.0 

func (s *Server) UpdateAppSettings(ctx context.Context, appPathGlob string, dryRun bool, updateAppRequest types.UpdateAppRequest) (*types.AppUpdateSettingsResponse, error)

func (*Server) VersionFiles added in v0.4.1 

func (s *Server) VersionFiles(ctx context.Context, mainAppPath, version string) (*types.AppVersionFilesResponse, error)

func (*Server) VersionList added in v0.4.1 

func (s *Server) VersionList(ctx context.Context, mainAppPath string) (*types.AppVersionListResponse, error)

func (*Server) VersionSwitch added in v0.4.1 

func (s *Server) VersionSwitch(ctx context.Context, mainAppPath string, dryRun bool, version string) (*types.AppVersionSwitchResponse, error)

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.