Skip to content
This repository has been archived by the owner on Feb 11, 2022. It is now read-only.

Commit

Permalink
Fix misspellings in code & README (#47)
Browse files Browse the repository at this point in the history
  • Loading branch information
vasilevp authored Jan 19, 2021
1 parent 0be8261 commit 85fe3d7
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 16 deletions.
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Extensible Enterprise Production Deployments for MongoDB Atlas

Table of Contents
=====
* [Intoduction](#introduction)
* [Introduction](#introduction)
* [Getting Started](#getting-started)
* [Specifications](#specifications)
* [Configuration Reference](#configuration-reference)
Expand All @@ -22,7 +22,7 @@ Table of Contents
* [License](#license)
* [Development](#development)

This project is a new version of the original [MongoDB Atlas Serivce Broker](https://github.com/mongodb/mongodb-atlas-service-broker) called "atlas-osb"
This project is a new version of the original [MongoDB Atlas Service Broker](https://github.com/mongodb/mongodb-atlas-service-broker) called "atlas-osb"

Atlas-osb adds the ability to define your own plans from Atlas resource templates. This new and powerful feature brings the broker to a new level of production-readiness. One simple *"create service"* command is all you need to provision a complete Atlas deployment including a Project, Cluster, Database user, firewall access, and more.

Expand Down Expand Up @@ -235,7 +235,7 @@ Configuration is handled with environment variables. Logs are written to
| `ATLAS_BROKER_TEMPLATEDIR` | | Path to folder containing plans e.g. ./samples/plans |

The values for the OSB "Service" for a given atlas-osb instance can be customized with a set of
additional environement variables. Each of these are optional, and has default content.
additional environment variables. Each of these are optional, and has default content.
Here are the settings for the `domain.Service` returned for each plan:

### OSB Service Metadata Configuration Reference
Expand All @@ -245,7 +245,7 @@ domain.Service:
| ----- | ------------- | --------- |
| `ID` | NONE | `"aosb-cluster-service-template"` |
| `Name` | `BROKER_OSB_SERVICE_NAME` | `"atlas"` |
| `Description` | `BROKER_OSB_SERVICE_DESC` | `"MonogoDB Atlas Plan Template Deployments"` |
| `Description` | `BROKER_OSB_SERVICE_DESC` | `"MongoDB Atlas Plan Template Deployments"` |
| `Metadata.DisplayName` | `BROKER_OSB_SERVICE_DISPLAY_NAME` | `"MongoDB Atlas - %s"` with `"Template Services"` |
| `Metadata.ImageUrl` | `BROKER_OSB_IMAGE_URL` | `"https://webassets.mongodb.com/_com_assets/cms/vectors-anchor-circle-mydmar539a.svg"` |
| `DocumentationUrl` | `BROKER_OSB_DOCS_URL` | `"https://support.mongodb.com/welcome"` |
Expand Down Expand Up @@ -367,7 +367,7 @@ In this section we describe the relationship between a Plan's OSB operations and

## Provisioning & Deprovisioning

When the broker gets a call to provision a plan, it will iterate through the various Atlas resources in the plan can call the corresponding service `Create` method. Similarily, when deprovisioning, the broker will delegate calls to the Atlas Go-client corresponding service `Delete` function.
When the broker gets a call to provision a plan, it will iterate through the various Atlas resources in the plan can call the corresponding service `Create` method. Similarly, when deprovisioning, the broker will delegate calls to the Atlas Go-client corresponding service `Delete` function.

Plans are loaded at startup and first validated before being made available in the Marketplace.

Expand All @@ -385,10 +385,10 @@ This section describes how the state of plan definitions and service instance me

atlas-osb introduces the use of MongoDB Realm applications to manage the state of your deployed service instances. This happens automatically, directly through the Atlas and Realm APIs.

The atlas-osb will create special project called "Atlas Service Broker Maintenance" for each Atlas Organization. Here, the broker will create a Realm App called "Broker State" :constuction: and use Realm Values to store reference data for the serivce instances you have deployed across your environments. This approach has several advantages:
The atlas-osb will create special project called "Atlas Service Broker Maintenance" for each Atlas Organization. Here, the broker will create a Realm App called "Broker State" :construction: and use Realm Values to store reference data for the service instances you have deployed across your environments. This approach has several advantages:

* zero-footprint on OSB-marketplace environment
* single location for all serivce instance metadata
* single location for all service instance metadata
* follows the Atlas organization boundaries, allows support for multi-tenancy scenarios
* automatically encrypted via Realm

Expand Down Expand Up @@ -523,7 +523,7 @@ TODO: MARK WHICH FIELDS ARE READ-ONLY? ie. users need to understand what can be
The following badges provide version and version-support information about Atlas-OSB for VMware Tanzu.

![Last Released Version](https://img.shields.io/github/v/release/mongodb/atlas-osb)
![Realease version](https://img.shields.io/github/release-date/mongodb/atlas-osb)
![Release version](https://img.shields.io/github/release-date/mongodb/atlas-osb)

![Compatible TAS versions](https://img.shields.io/badge/tested%20on%20TAS-2.9.0-important)
![Credhubversion](https://img.shields.io/badge/CredHub%20version-1.4.7-important)
Expand Down
2 changes: 1 addition & 1 deletion pkg/broker/binding_operations.go
Original file line number Diff line number Diff line change
Expand Up @@ -200,7 +200,7 @@ func generatePassword() (string, error) {

func (b *Broker) userFromParams(bindingID string, password string, rawParams []byte, plan *dynamicplans.Plan) (*mongodbatlas.DatabaseUser, error) {
logger := b.funcLogger().With("binding_id", bindingID)
// Set up a params object which will be used for deserialiation.
// Set up a params object which will be used for deserialization.
params := struct {
User *mongodbatlas.DatabaseUser `json:"user"`
}{
Expand Down
13 changes: 6 additions & 7 deletions pkg/broker/statestorage/statestorage.go
Original file line number Diff line number Diff line change
Expand Up @@ -72,12 +72,12 @@ func Get(ctx context.Context, key credentials.APIKey, userAgent string, atlasURL
return nil, errors.Wrap(err, "cannot create Atlas client")
}

mainPrj, err := getOrCreateBrokerMaintentaceGroup(ctx, key.OrgID, client, logger)
mainPrj, err := getOrCreateBrokerMaintenanceGroup(ctx, key.OrgID, client, logger)
if err != nil {
return nil, err
}

logger.Infow("Found mainteneance project", "mainPrj", mainPrj)
logger.Infow("Found maintenance project", "mainPrj", mainPrj)
realmApp, err := getOrCreateRealmAppForOrg(ctx, mainPrj.ID, realmClient, logger)
if err != nil {
logger.Errorw("Error getOrCreateRealmAppForOrg", "err", err)
Expand All @@ -96,10 +96,10 @@ func Get(ctx context.Context, key credentials.APIKey, userAgent string, atlasURL
return rss, nil
}

func getOrCreateBrokerMaintentaceGroup(ctx context.Context, orgID string, client *mongodbatlas.Client, logger *zap.SugaredLogger) (*mongodbatlas.Project, error) {
func getOrCreateBrokerMaintenanceGroup(ctx context.Context, orgID string, client *mongodbatlas.Client, logger *zap.SugaredLogger) (*mongodbatlas.Project, error) {
project, _, err := client.Projects.GetOneProjectByName(ctx, maintenanceProjectName)
if err != nil {
logger.Infow("getOrCreateBrokerMaintentaceGroup", "err", err)
logger.Infow("getOrCreateBrokerMaintenanceGroup", "err", err)
prj := mongodbatlas.Project{
Name: maintenanceProjectName,
OrgID: orgID,
Expand All @@ -110,10 +110,9 @@ func getOrCreateBrokerMaintentaceGroup(ctx context.Context, orgID string, client
return nil, errors.Wrap(err, "cannot create project")
}

logger.Infow("getOrCreateBrokerMaintentaceGroup CREATED", "project", project)
logger.Debugw("getOrCreateBrokerMaintenanceGroup CREATED", "project", project)
}
logger.Infow("getOrCreateBrokerMaintentaceGroup FOUND", "project", project)

logger.Debugw("getOrCreateBrokerMaintenanceGroup FOUND", "project", project)
return project, nil
}

Expand Down

0 comments on commit 85fe3d7

Please sign in to comment.