Documentation
¶
Overview ¶
Package msgs defines the messages emitted by onboarding steps. These are the contracts between steps and the onboarding orchestrator.
Index ¶
- Constants
- type AccountCreated
- type AccountSelected
- type AuthChecked
- type Authenticated
- type DatadogAPIKeyEntered
- type DatadogAccountCreated
- type DatadogDiscoveryComplete
- type DatadogNeeded
- type DatadogReady
- type DatadogRegionSelected
- type NoAccounts
- type NoOrgs
- type OnboardingComplete
- type OrgCreated
- type OrgSelected
- type RoleSelected
- type SyncComplete
- type WorkspaceSelected
Constants ¶
const ( RolePlatform = "platform" RoleEngineer = "engineer" )
Role constants.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AccountCreated ¶
type AccountCreated struct {
Org domain.Organization
Account domain.Account
}
AccountCreated is emitted when a new account is created.
type AccountSelected ¶
type AccountSelected struct {
Org domain.Organization
Account domain.Account
}
AccountSelected is emitted when user selects an account.
type AuthChecked ¶
type AuthChecked struct {
NeedsAuth bool
}
AuthChecked is emitted when the auth check completes.
type Authenticated ¶
Authenticated is emitted when authentication succeeds.
type DatadogAPIKeyEntered ¶
type DatadogAPIKeyEntered struct {
APIKey string
}
DatadogAPIKeyEntered is emitted when user enters API key.
type DatadogAccountCreated ¶
type DatadogAccountCreated struct {
DatadogAccountID domain.DatadogAccountID
}
DatadogAccountCreated is emitted when datadog account is created.
type DatadogDiscoveryComplete ¶
type DatadogDiscoveryComplete struct{}
DatadogDiscoveryComplete is emitted when discovery finishes.
type DatadogNeeded ¶
type DatadogNeeded struct{}
DatadogNeeded is emitted when datadog setup is required.
type DatadogReady ¶
type DatadogReady struct{}
DatadogReady is emitted when datadog is already configured.
type DatadogRegionSelected ¶
type DatadogRegionSelected struct {
Site domain.DatadogSite
}
DatadogRegionSelected is emitted when user selects a datadog region.
type NoAccounts ¶
type NoAccounts struct {
Org domain.Organization
}
NoAccounts is emitted when no accounts exist for the org.
type OnboardingComplete ¶
type OnboardingComplete struct {
User *auth.User
Org domain.Organization
Account domain.Account
Workspace domain.Workspace
}
OnboardingComplete is emitted to the root model when onboarding finishes.
type OrgCreated ¶
type OrgCreated struct {
Org domain.Organization
}
OrgCreated is emitted when a new organization is created.
type OrgSelected ¶
type OrgSelected struct {
Org domain.Organization
}
OrgSelected is emitted when user selects an organization.
type RoleSelected ¶
type RoleSelected struct {
Role string
}
RoleSelected is emitted when user selects their role.
type WorkspaceSelected ¶
WorkspaceSelected is emitted when user selects a workspace.
Source Files