Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
- API
  
  Reference documentation for the pkg.go.dev API
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

bootstrap

package

Go to main page

Versions in this module

v0

v0.2.0

May 26, 2026

Changes in this version

+ type RepairDefaultACLsInput struct

+ DryRun bool

+ Organization string

+ type RepairDefaultACLsResult struct

+ BootstrapRepaired []string

+ Changed bool

+ CoreObjectRepaired []string

+ type RepairGroupMembershipInput struct

+ Action string

+ Actor string

+ ActorType string

+ Group string

+ Organization string

+ type RepairMembershipResult struct

+ Changed bool

+ Members []string

+ type RepairOrgMembershipInput struct

+ Action string

+ Admin bool

+ Force bool

+ Organization string

+ Username string

+ type RepairServerAdminMembershipInput struct

+ Action string

+ Username string

type Service

+ func (s *Service) ListServerAdmins() []string

+ func (s *Service) ReloadPersistedState() error

+ func (s *Service) RepairDefaultACLs(input RepairDefaultACLsInput) (RepairDefaultACLsResult, error)

+ func (s *Service) RepairGroupMembership(input RepairGroupMembershipInput) (RepairMembershipResult, error)

+ func (s *Service) RepairOrgMembership(input RepairOrgMembershipInput) (RepairMembershipResult, error)

+ func (s *Service) RepairServerAdminMembership(input RepairServerAdminMembershipInput) (RepairMembershipResult, error)

v0.1.0

Apr 30, 2026

Changes in this version

+ var ErrConflict = errors.New("resource already exists")

+ var ErrImmutable = errors.New("resource cannot be modified")

+ var ErrInvalidInput = errors.New("invalid input")

+ var ErrNotFound = errors.New("resource not found")

+ func ListBootstrapServerAdmins(state BootstrapCoreState) []string

+ func RepairBootstrapCoreDefaultACLs(state BootstrapCoreState, orgFilter, superuserName string) (BootstrapCoreState, AdminRepairResult)

+ func RepairCoreObjectDefaultACLs(state CoreObjectState, orgFilter, superuserName string) (CoreObjectState, AdminRepairResult)

+ func ValidCookbookRouteVersion(value string) bool

+ func ValidSandboxChecksum(value string) bool

+ type AdminRepairResult struct

+ Changed bool

+ Repaired []string

+ type BootstrapCoreOrganizationState struct

+ ACLs map[string]authz.ACL

+ ClientKeys map[string]map[string]KeyRecord

+ Clients map[string]Client

+ Containers map[string]Container

+ Groups map[string]Group

+ Organization Organization

+ type BootstrapCoreState struct

+ Orgs map[string]BootstrapCoreOrganizationState

+ UserACLs map[string]authz.ACL

+ UserKeys map[string]map[string]KeyRecord

+ Users map[string]User

+ func AddActorToBootstrapCoreGroup(state BootstrapCoreState, orgName, groupName, actorType, actorName string) (BootstrapCoreState, []string, error)

+ func AddUserToBootstrapCoreOrg(state BootstrapCoreState, orgName, username string, admin bool) (BootstrapCoreState, []string, error)

+ func CloneBootstrapCoreState(state BootstrapCoreState) BootstrapCoreState

+ func GrantBootstrapServerAdmin(state BootstrapCoreState, username string) (BootstrapCoreState, []string, error)

+ func RemoveActorFromBootstrapCoreGroup(state BootstrapCoreState, orgName, groupName, actorType, actorName string) (BootstrapCoreState, []string, error)

+ func RemoveUserFromBootstrapCoreOrg(state BootstrapCoreState, orgName, username string, force bool) (BootstrapCoreState, []string, error)

+ func RevokeBootstrapServerAdmin(state BootstrapCoreState, username string) (BootstrapCoreState, []string, error)

+ type BootstrapCoreStore interface

+ LoadBootstrapCore func() (BootstrapCoreState, error)

+ SaveBootstrapCore func(BootstrapCoreState) error

+ type Client struct

+ Admin bool

+ ClientName string

+ Name string

+ Organization string

+ PublicKey string

+ URI string

+ Validator bool

+ type Container struct

+ ContainerName string

+ ContainerPath string

+ Name string

+ type CookbookArtifact struct

+ AllFiles []CookbookFile

+ ChefType string

+ Frozen bool

+ Identifier string

+ Metadata map[string]any

+ Name string

+ Version string

+ type CookbookFile struct

+ Checksum string

+ Name string

+ Path string

+ Specificity string

+ type CookbookStore interface

+ CookbookChecksumReferenced func(checksum string) bool

+ CreateCookbookArtifact func(orgName string, artifact CookbookArtifact) (CookbookArtifact, error)

+ DeleteCookbookArtifactWithReleasedChecksums func(orgName, name, identifier string) (CookbookArtifact, []string, error)

+ DeleteCookbookChecksumReferencesFromRemaining func(remaining map[string]struct{})

+ DeleteCookbookVersionWithReleasedChecksums func(orgName, name, version string) (CookbookVersion, []string, error)

+ GetCookbookArtifact func(orgName, name, identifier string) (CookbookArtifact, bool, bool)

+ GetCookbookVersion func(orgName, name, version string) (CookbookVersion, bool, bool)

+ HasCookbookVersion func(orgName, name, version string) (bool, bool)

+ ListCookbookArtifacts func(orgName string) (map[string][]CookbookArtifact, bool)

+ ListCookbookArtifactsByName func(orgName, name string) ([]CookbookArtifact, bool, bool)

+ ListCookbookVersionModelsByName func(orgName, name string) ([]CookbookVersion, bool, bool)

+ ListCookbookVersions func(orgName string) (map[string][]CookbookVersionRef, bool)

+ ListCookbookVersionsByName func(orgName, name string) ([]CookbookVersionRef, bool, bool)

+ UpsertCookbookVersionWithReleasedChecksums func(orgName string, version CookbookVersion, force bool) (CookbookVersion, []string, bool, error)

+ type CookbookVersion struct

+ AllFiles []CookbookFile

+ ChefType string

+ CookbookName string

+ Frozen bool

+ JSONClass string

+ Metadata map[string]any

+ Name string

+ Version string

+ type CookbookVersionRef struct

+ Name string

+ Version string

+ type CoreObjectOrganizationState struct

+ ACLs map[string]authz.ACL

+ DataBagItems map[string]map[string]DataBagItem

+ DataBags map[string]DataBag

+ Environments map[string]Environment

+ Nodes map[string]Node

+ Policies map[string]map[string]PolicyRevision

+ PolicyGroups map[string]PolicyGroup

+ Roles map[string]Role

+ Sandboxes map[string]Sandbox

+ type CoreObjectState struct

+ Orgs map[string]CoreObjectOrganizationState

+ func CloneCoreObjectState(state CoreObjectState) CoreObjectState

+ type CoreObjectStore interface

+ LoadCoreObjects func() (CoreObjectState, error)

+ SaveCoreObjects func(CoreObjectState) error

+ type CreateClientInput struct

+ Admin bool

+ CreateDefaultKey bool

+ Name string

+ PublicKey string

+ Validator bool

+ type CreateCookbookArtifactInput struct

+ ChecksumExists func(string) (bool, error)

+ Identifier string

+ Name string

+ Payload map[string]any

+ type CreateDataBagInput struct

+ Creator authn.Principal

+ Payload map[string]any

+ type CreateDataBagItemInput struct

+ Payload map[string]any

+ type CreateEnvironmentInput struct

+ Creator authn.Principal

+ Payload map[string]any

+ type CreateKeyInput struct

+ CreateKey bool

+ ExpirationDate string

+ Name string

+ PublicKey string

+ type CreateNodeInput struct

+ Creator authn.Principal

+ Payload map[string]any

+ type CreateOrganizationInput struct

+ FullName string

+ Name string

+ OrgType string

+ OwnerName string

+ type CreatePolicyRevisionInput struct

+ Creator authn.Principal

+ Payload map[string]any

+ type CreateRoleInput struct

+ Creator authn.Principal

+ Payload map[string]any

+ type CreateSandboxInput struct

+ Checksums []string

+ type CreateUserInput struct

+ CreateDefaultKey bool

+ DisplayName string

+ Email string

+ FirstName string

+ LastName string

+ PublicKey string

+ Username string

+ type DataBag struct

+ ChefType string

+ JSONClass string

+ Name string

+ type DataBagItem struct

+ ID string

+ RawData map[string]any

+ type DepsolverError struct

+ Detail map[string]any

+ func (e *DepsolverError) Error() string

+ type Environment struct

+ ChefType string

+ CookbookVersions map[string]string

+ DefaultAttributes map[string]any

+ Description string

+ JSONClass string

+ Name string

+ OverrideAttributes map[string]any

+ type FrozenCookbookError struct

+ Name string

+ Version string

+ func (e *FrozenCookbookError) Error() string

+ func (e *FrozenCookbookError) Unwrap() error

+ type Group struct

+ Actors []string

+ Clients []string

+ GroupName string

+ Groups []string

+ Name string

+ Organization string

+ Users []string

+ type KeyMaterial struct

+ ExpirationDate string

+ Name string

+ PrivateKeyPEM string

+ PublicKeyPEM string

+ URI string

+ type KeyRecord struct

+ ExpirationDate string

+ Expired bool

+ ExpiresAt *time.Time

+ Name string

+ PublicKeyPEM string

+ URI string

+ type MemoryBootstrapCoreStore struct

+ func NewMemoryBootstrapCoreStore(initial BootstrapCoreState) *MemoryBootstrapCoreStore

+ func (s *MemoryBootstrapCoreStore) LoadBootstrapCore() (BootstrapCoreState, error)

+ func (s *MemoryBootstrapCoreStore) SaveBootstrapCore(state BootstrapCoreState) error

+ type MemoryCoreObjectStore struct

+ func NewMemoryCoreObjectStore(initial CoreObjectState) *MemoryCoreObjectStore

+ func (s *MemoryCoreObjectStore) LoadCoreObjects() (CoreObjectState, error)

+ func (s *MemoryCoreObjectStore) SaveCoreObjects(state CoreObjectState) error

+ type MissingChecksumError struct

+ Checksum string

+ func (e *MissingChecksumError) Error() string

+ type Node struct

+ Automatic map[string]any

+ ChefEnvironment string

+ ChefType string

+ Default map[string]any

+ JSONClass string

+ Name string

+ Normal map[string]any

+ Override map[string]any

+ PolicyGroup string

+ PolicyName string

+ RunList []string

+ type Options struct

+ BootstrapCoreStoreFactory func(*Service) BootstrapCoreStore

+ CookbookStoreFactory func(*Service) CookbookStore

+ CoreObjectStoreFactory func(*Service) CoreObjectStore

+ InitialBootstrapCoreState *BootstrapCoreState

+ InitialCoreObjectState *CoreObjectState

+ SuperuserName string

+ type Organization struct

+ FullName string

+ GUID string

+ Name string

+ OrgType string

+ type PolicyAssignmentPlan struct

+ CreatesPolicy bool

+ CreatesRevision bool

+ Revision PolicyRevision

+ type PolicyGroup struct

+ Name string

+ Policies map[string]string

+ type PolicyRevision struct

+ Name string

+ Payload map[string]any

+ RevisionID string

+ type Role struct

+ ChefType string

+ DefaultAttributes map[string]any

+ Description string

+ EnvRunLists map[string][]string

+ JSONClass string

+ Name string

+ OverrideAttributes map[string]any

+ RunList []string

+ type Sandbox struct

+ Checksums []string

+ CreatedAt time.Time

+ ID string

+ Organization string

+ type Service struct

+ func NewService(keyStore *authn.MemoryKeyStore, opts Options) *Service

+ func (s *Service) AddUserToGroup(orgName, groupName, username string) error

+ func (s *Service) CleanupUnreferencedChecksums(candidates []string, cleanup func(string) error) error

+ func (s *Service) CookbookUniverse(orgName string) (map[string][]UniverseEntry, bool)

+ func (s *Service) CreateClient(orgName string, input CreateClientInput) (Client, *KeyMaterial, error)

+ func (s *Service) CreateClientKey(orgName, clientName string, input CreateKeyInput) (*KeyMaterial, error)

+ func (s *Service) CreateCookbookArtifact(orgName string, input CreateCookbookArtifactInput) (CookbookArtifact, error)

+ func (s *Service) CreateDataBag(orgName string, input CreateDataBagInput) (DataBag, error)

+ func (s *Service) CreateDataBagItem(orgName, bagName string, input CreateDataBagItemInput) (DataBagItem, error)

+ func (s *Service) CreateEnvironment(orgName string, input CreateEnvironmentInput) (Environment, error)

+ func (s *Service) CreateNode(orgName string, input CreateNodeInput) (Node, error)

+ func (s *Service) CreateOrganization(input CreateOrganizationInput) (Organization, Client, *KeyMaterial, error)

+ func (s *Service) CreatePolicyRevision(orgName, targetName string, input CreatePolicyRevisionInput) (PolicyRevision, error)

+ func (s *Service) CreateRole(orgName string, input CreateRoleInput) (Role, error)

+ func (s *Service) CreateSandbox(orgName string, input CreateSandboxInput) (Sandbox, error)

+ func (s *Service) CreateUser(input CreateUserInput) (User, *KeyMaterial, error)

+ func (s *Service) CreateUserKey(name string, input CreateKeyInput) (*KeyMaterial, error)

+ func (s *Service) DeleteClient(orgName, clientName string) (Client, error)

+ func (s *Service) DeleteClientKey(orgName, clientName, keyName string) error

+ func (s *Service) DeleteCookbookArtifact(orgName, name, identifier string) (CookbookArtifact, error)

+ func (s *Service) DeleteCookbookArtifactWithReleasedChecksums(orgName, name, identifier string) (CookbookArtifact, []string, error)

+ func (s *Service) DeleteCookbookVersion(orgName, name, version string) (CookbookVersion, error)

+ func (s *Service) DeleteCookbookVersionWithReleasedChecksums(orgName, name, version string) (CookbookVersion, []string, error)

+ func (s *Service) DeleteDataBag(orgName, bagName string) (DataBag, error)

+ func (s *Service) DeleteDataBagItem(orgName, bagName, itemID string) (DataBagItem, error)

+ func (s *Service) DeleteEnvironment(orgName, name string) (Environment, error)

+ func (s *Service) DeleteNode(orgName, nodeName string) (Node, error)

+ func (s *Service) DeletePolicy(orgName, policyName string) ([]string, error)

+ func (s *Service) DeletePolicyGroup(orgName, groupName string) (PolicyGroup, error)

+ func (s *Service) DeletePolicyGroupAssignment(orgName, groupName, policyName string) (PolicyRevision, error)

+ func (s *Service) DeletePolicyRevision(orgName, policyName, revisionID string) (PolicyRevision, error)

+ func (s *Service) DeleteRole(orgName, roleName string) (Role, error)

+ func (s *Service) DeleteSandbox(orgName, sandboxID string) (Sandbox, error)

+ func (s *Service) DeleteUserKey(name, keyName string) error

+ func (s *Service) GetClient(orgName, clientName string) (Client, bool)

+ func (s *Service) GetClientKey(orgName, clientName, keyName string) (KeyRecord, bool, bool, bool)

+ func (s *Service) GetContainer(orgName, containerName string) (Container, bool)

+ func (s *Service) GetCookbookArtifact(orgName, name, identifier string) (CookbookArtifact, bool, bool)

+ func (s *Service) GetCookbookVersion(orgName, name, version string) (CookbookVersion, bool, bool)

+ func (s *Service) GetDataBag(orgName, bagName string) (DataBag, bool, bool)

+ func (s *Service) GetDataBagItem(orgName, bagName, itemID string) (DataBagItem, bool, bool, bool)

+ func (s *Service) GetEnvironment(orgName, name string) (Environment, bool, bool)

+ func (s *Service) GetEnvironmentCookbookVersions(orgName, environmentName, cookbookName string, numVersions int, ...) ([]CookbookVersionRef, bool, bool, bool)

+ func (s *Service) GetGroup(orgName, groupName string) (Group, bool)

+ func (s *Service) GetNode(orgName, nodeName string) (Node, bool, bool)

+ func (s *Service) GetOrganization(name string) (Organization, bool)

+ func (s *Service) GetPolicy(orgName, policyName string) (map[string]PolicyRevision, bool, bool)

+ func (s *Service) GetPolicyGroup(orgName, groupName string) (PolicyGroup, bool, bool)

+ func (s *Service) GetPolicyGroupAssignment(orgName, groupName, policyName string) (PolicyRevision, bool, bool, bool)

+ func (s *Service) GetPolicyRevision(orgName, policyName, revisionID string) (PolicyRevision, bool, bool, bool)

+ func (s *Service) GetRole(orgName, roleName string) (Role, bool, bool)

+ func (s *Service) GetSandbox(orgName, sandboxID string) (Sandbox, bool, bool)

+ func (s *Service) GetUser(name string) (User, bool)

+ func (s *Service) GetUserKey(name, keyName string) (KeyRecord, bool, bool)

+ func (s *Service) GroupsFor(_ context.Context, subject authz.Subject) ([]string, error)

+ func (s *Service) ListClientKeys(orgName, clientName string) ([]KeyRecord, bool, bool)

+ func (s *Service) ListClients(orgName string) (map[string]string, bool)

+ func (s *Service) ListContainers(orgName string) (map[string]string, bool)

+ func (s *Service) ListCookbookArtifacts(orgName string) (map[string][]CookbookArtifact, bool)

+ func (s *Service) ListCookbookArtifactsByName(orgName, name string) ([]CookbookArtifact, bool, bool)

+ func (s *Service) ListCookbookVersions(orgName string) (map[string][]CookbookVersionRef, bool)

+ func (s *Service) ListCookbookVersionsByName(orgName, name string) ([]CookbookVersionRef, bool, bool)

+ func (s *Service) ListDataBagItems(orgName, bagName string) (map[string]string, bool, bool)

+ func (s *Service) ListDataBags(orgName string) (map[string]string, bool)

+ func (s *Service) ListEnvironmentCookbookVersions(orgName, environmentName string, numVersions int, allVersions bool) (map[string][]CookbookVersionRef, bool, bool)

+ func (s *Service) ListEnvironmentNodes(orgName, environmentName string) (map[string]string, bool, bool)

+ func (s *Service) ListEnvironments(orgName string) (map[string]string, bool)

+ func (s *Service) ListGroups(orgName string) (map[string]string, bool)

+ func (s *Service) ListNodes(orgName string) (map[string]string, bool)

+ func (s *Service) ListOrganizations() map[string]string

+ func (s *Service) ListPolicies(orgName string) (map[string][]string, bool)

+ func (s *Service) ListPolicyGroups(orgName string) (map[string]PolicyGroup, bool)

+ func (s *Service) ListRoles(orgName string) (map[string]string, bool)

+ func (s *Service) ListUserKeys(name string) ([]KeyRecord, bool)

+ func (s *Service) ListUsers() map[string]string

+ func (s *Service) PolicyGroupsForRevision(orgName, policyName, revisionID string) ([]string, bool, bool, bool)

+ func (s *Service) PreviewPolicyGroupAssignment(orgName, targetPolicyName string, payload map[string]any) (PolicyAssignmentPlan, error)

+ func (s *Service) RehydrateKeyStore() error

+ func (s *Service) ResolveACL(_ context.Context, resource authz.Resource) (authz.ACL, bool, error)

+ func (s *Service) SeedPrincipal(principal authn.Principal)

+ func (s *Service) SeedPublicKey(principal authn.Principal, name, publicKeyPEM string) error

+ func (s *Service) SolveEnvironmentCookbookVersions(orgName, environmentName string, payload map[string]any) (map[string]CookbookVersion, bool, bool, error)

+ func (s *Service) SuperuserName() string

+ func (s *Service) UpdateClient(orgName, clientName string, input UpdateClientInput) (Client, *KeyMaterial, error)

+ func (s *Service) UpdateClientKey(orgName, clientName, keyName string, input UpdateKeyInput) (UpdateKeyResult, error)

+ func (s *Service) UpdateDataBagItem(orgName, bagName, itemID string, input UpdateDataBagItemInput) (DataBagItem, error)

+ func (s *Service) UpdateEnvironment(orgName, currentName string, input UpdateEnvironmentInput) (UpdateEnvironmentResult, error)

+ func (s *Service) UpdateNode(orgName, nodeName string, input UpdateNodeInput) (Node, error)

+ func (s *Service) UpdateRole(orgName, roleName string, input UpdateRoleInput) (Role, error)

+ func (s *Service) UpdateUser(input UpdateUserInput) (User, *KeyMaterial, error)

+ func (s *Service) UpdateUserKey(name, keyName string, input UpdateKeyInput) (UpdateKeyResult, error)

+ func (s *Service) UpsertCookbookVersion(orgName string, input UpsertCookbookVersionInput) (CookbookVersion, bool, error)

+ func (s *Service) UpsertCookbookVersionWithReleasedChecksums(orgName string, input UpsertCookbookVersionInput) (CookbookVersion, []string, bool, error)

+ func (s *Service) UpsertPolicyGroupAssignment(orgName, groupName, targetPolicyName string, ...) (PolicyRevision, bool, error)

+ type UniverseEntry struct

+ Dependencies map[string]string

+ Version string

+ type UpdateClientInput struct

+ Admin *bool

+ PublicKey *string

+ Validator *bool

+ type UpdateDataBagItemInput struct

+ Payload map[string]any

+ type UpdateEnvironmentInput struct

+ Payload map[string]any

+ type UpdateEnvironmentResult struct

+ Environment Environment

+ Renamed bool

+ type UpdateKeyInput struct

+ CreateKey *bool

+ ExpirationDate *string

+ Name *string

+ PublicKey *string

+ type UpdateKeyResult struct

+ KeyMaterial KeyMaterial

+ Renamed bool

+ type UpdateNodeInput struct

+ Payload map[string]any

+ type UpdatePolicyGroupAssignmentInput struct

+ Creator authn.Principal

+ Payload map[string]any

+ type UpdateRoleInput struct

+ Payload map[string]any

+ type UpdateUserInput struct

+ DisplayName *string

+ Email *string

+ FirstName *string

+ LastName *string

+ PublicKey *string

+ Username string

+ type UpsertCookbookVersionInput struct

+ ChecksumExists func(string) (bool, error)

+ Force bool

+ Name string

+ Payload map[string]any

+ Version string

+ type User struct

+ DisplayName string

+ Email string

+ FirstName string

+ LastName string

+ Username string

+ type ValidationError struct

+ Messages []string

+ func ValidateDepsolverPayload(payload map[string]any) *ValidationError

+ func (e *ValidationError) Error() string