Documentation
      ¶
    
    
  
    
  
    Index ¶
- Constants
 - func BasicUser(crName, atlasUserName string, add ...func(user *akov2.AtlasDatabaseUser)) *akov2.AtlasDatabaseUser
 - func CreateAdvancedDeployment(name string) *akov2.AtlasDeployment
 - func CreateAdvancedGeoshardedDeployment(name string) *akov2.AtlasDeployment
 - func CreateBasicDeployment(name string) *akov2.AtlasDeployment
 - func CreateDeploymentWithBackup(name string) *akov2.AtlasDeployment
 - func CreateDeploymentWithKeepPolicy(name string) *akov2.AtlasDeployment
 - func CreateDeploymentWithMultiregion(name string, providerName provider.ProviderName) *akov2.AtlasDeployment
 - func CreateDeploymentWithMultiregionAWS(name string) *akov2.AtlasDeployment
 - func CreateDeploymentWithMultiregionAzure(name string) *akov2.AtlasDeployment
 - func CreateDeploymentWithMultiregionGCP(name string) *akov2.AtlasDeployment
 - func CreateFreeAdvancedDeployment(name string) *akov2.AtlasDeployment
 - func DefaultProject() *akov2.AtlasProject
 - func NewDeploymentWithBackupSpec() akov2.AtlasDeploymentSpec
 - func WithAdminRole() func(user *akov2.AtlasDatabaseUser)
 - func WithCredentials(secretName string) func(user *akov2.AtlasDatabaseUser)
 - func WithCustomRole(role, db, collection string) func(user *akov2.AtlasDatabaseUser)
 - func WithExternalProjectRef(projectID, credentialsName string) func(user *akov2.AtlasDatabaseUser)
 - func WithLabels(labels []common.LabelSpec) func(user *akov2.AtlasDatabaseUser)
 - func WithNamespace(namespace string) func(user *akov2.AtlasDatabaseUser)
 - func WithOIDCEnabled() func(user *akov2.AtlasDatabaseUser)
 - func WithProject(project *akov2.AtlasProject) func(user *akov2.AtlasDatabaseUser)
 - func WithReadWriteRole() func(user *akov2.AtlasDatabaseUser)
 - func WithSecretRef(name string) func(user *akov2.AtlasDatabaseUser)
 - func WithX509(newUserName string) func(user *akov2.AtlasDatabaseUser)
 
Constants ¶
      View Source
      
  
    const ( InstanceSizeM10 = "M10" InstanceSizeM20 = "M20" InstanceSizeM0 = "M0" AWSRegion = "US_EAST_1" )
      View Source
      
  
    const ( // build-in dbroles RoleBuildInAdmin string = "atlasAdmin" RoleBuildInReadWriteAny string = "readWriteAnyDatabase" RoleBuildInReadAny string = "readAnyDatabase" DefaultDatabaseName = "admin" )
      View Source
      
  
const ProjectName = "my-project"
    Variables ¶
This section is empty.
Functions ¶
func BasicUser ¶
func BasicUser(crName, atlasUserName string, add ...func(user *akov2.AtlasDatabaseUser)) *akov2.AtlasDatabaseUser
func CreateAdvancedDeployment ¶
func CreateAdvancedDeployment(name string) *akov2.AtlasDeployment
func CreateAdvancedGeoshardedDeployment ¶
func CreateAdvancedGeoshardedDeployment(name string) *akov2.AtlasDeployment
func CreateBasicDeployment ¶
func CreateBasicDeployment(name string) *akov2.AtlasDeployment
func CreateDeploymentWithBackup ¶
func CreateDeploymentWithBackup(name string) *akov2.AtlasDeployment
func CreateDeploymentWithKeepPolicy ¶
func CreateDeploymentWithKeepPolicy(name string) *akov2.AtlasDeployment
func CreateDeploymentWithMultiregion ¶
func CreateDeploymentWithMultiregion(name string, providerName provider.ProviderName) *akov2.AtlasDeployment
func CreateDeploymentWithMultiregionAWS ¶
func CreateDeploymentWithMultiregionAWS(name string) *akov2.AtlasDeployment
func CreateDeploymentWithMultiregionAzure ¶
func CreateDeploymentWithMultiregionAzure(name string) *akov2.AtlasDeployment
func CreateDeploymentWithMultiregionGCP ¶
func CreateDeploymentWithMultiregionGCP(name string) *akov2.AtlasDeployment
func CreateFreeAdvancedDeployment ¶
func CreateFreeAdvancedDeployment(name string) *akov2.AtlasDeployment
func DefaultProject ¶
func DefaultProject() *akov2.AtlasProject
func NewDeploymentWithBackupSpec ¶
func NewDeploymentWithBackupSpec() akov2.AtlasDeploymentSpec
func WithAdminRole ¶
func WithAdminRole() func(user *akov2.AtlasDatabaseUser)
func WithCredentials ¶ added in v2.5.0
func WithCredentials(secretName string) func(user *akov2.AtlasDatabaseUser)
func WithCustomRole ¶
func WithCustomRole(role, db, collection string) func(user *akov2.AtlasDatabaseUser)
func WithExternalProjectRef ¶ added in v2.5.0
func WithExternalProjectRef(projectID, credentialsName string) func(user *akov2.AtlasDatabaseUser)
func WithLabels ¶ added in v2.4.1
func WithLabels(labels []common.LabelSpec) func(user *akov2.AtlasDatabaseUser)
func WithNamespace ¶
func WithNamespace(namespace string) func(user *akov2.AtlasDatabaseUser)
func WithOIDCEnabled ¶ added in v2.1.0
func WithOIDCEnabled() func(user *akov2.AtlasDatabaseUser)
func WithProject ¶
func WithProject(project *akov2.AtlasProject) func(user *akov2.AtlasDatabaseUser)
func WithReadWriteRole ¶
func WithReadWriteRole() func(user *akov2.AtlasDatabaseUser)
func WithSecretRef ¶
func WithSecretRef(name string) func(user *akov2.AtlasDatabaseUser)
func WithX509 ¶
func WithX509(newUserName string) func(user *akov2.AtlasDatabaseUser)
Types ¶
This section is empty.
 Click to show internal directories. 
   Click to hide internal directories.