-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
ajosh0504
committed
Feb 24, 2025
1 parent
cc8b36b
commit 70de8e4
Showing
51 changed files
with
205 additions
and
49 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,67 @@ | ||
import Link from "@site/src/components/Link"; | ||
import Screenshot from "@site/src/components/Screenshot"; | ||
|
||
# 👐 Create your account | ||
|
||
:::caution | ||
If you are doing this lab as part of a MongoDB GenAI Developer Day, at this point you should already have a free cluster, so you can skip this step and continue <a href="../dev-env/dev-env-setup">setting up the dev environment</a> for the lab. | ||
|
||
If you don't have a cluster yet, follow the steps below to create one. | ||
::: | ||
|
||
In this lab, you will learn how to use MongoDB Atlas Vector Search. | ||
|
||
To use MongoDB Atlas, you will need to start by creating an account. | ||
|
||
<details> | ||
<summary> 🦹♀️ If you already have an Atlas account, you can use it by creating a new project.</summary> | ||
|
||
First, log into <Link to="https://account.mongodb.com/">MongoDB Atlas</Link> using your existing credentials. | ||
|
||
<Screenshot url="https://account.mongodb.com" src={"img/screenshots/20-mongodb-atlas/1-create-account/3-login.png"} alt="Login form" /> | ||
|
||
## Create a new Atlas project | ||
|
||
Once you're in Atlas, open the dropdown on the left-top corner of the page and select **New Project**. | ||
|
||
<Screenshot url="https://cloud.mongodb.com" src={"img/screenshots/20-mongodb-atlas/1-create-account/4-new-project.png"} alt="Create new project" /> | ||
|
||
Enter a name for your project and click **Next**. | ||
|
||
<Screenshot url="https://cloud.mongodb.com" src={"img/screenshots/20-mongodb-atlas/1-create-account/5-new-project-name.png"} alt="Create new project" /> | ||
|
||
On the next page, you can leave the current user as the project owner, and click **Create Project**. | ||
|
||
Once the project is ready, continue the workshop from the <a href="./create-cluster">**Deploy a database cluster**</a> section. | ||
</details> | ||
|
||
## Sign up for MongoDB Atlas | ||
|
||
:::caution | ||
Some corporate email accounts have restrictions on their use with Atlas. Consider using your personal account instead. | ||
::: | ||
|
||
|
||
Go to the <Link to="http://mongodb.com/try">MongoDB website</Link> and create your account. You will be greeted by a form similar to the one below. | ||
|
||
<Screenshot url="https://cloud.mongodb.com" src={"img/screenshots/20-mongodb-atlas/1-create-account/1-form.png"} alt="Account creation form" /> | ||
|
||
:::info | ||
If you are doing this lab at an event, you should use the same email address you used to register for the event. | ||
::: | ||
|
||
Complete the form and click the "Create Your Atlas Account" button. | ||
|
||
## Verify your email address | ||
|
||
You will receive an email from MongoDB asking you to verify your email address. Click the link in the email to verify your email address. | ||
|
||
<Screenshot url="https://cloud.mongodb.com" src={"img/screenshots/20-mongodb-atlas/1-create-account/2-verify-email.png"} alt="Verify your email address" /> | ||
|
||
:::caution | ||
If you haven't received the email within two minutes, check your spam folder. | ||
::: | ||
|
||
## Finish the onboarding | ||
|
||
You will be redirected to the MongoDB Atlas onboarding wizard. Fill in the form and click "Finish" to continue. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,67 @@ | ||
import Screenshot from "@site/src/components/Screenshot"; | ||
|
||
# 👐 Deploy a database cluster | ||
|
||
Now that you have a MongoDB Atlas account, you can create your first cluster for free. | ||
|
||
It won't expire, and you will have a 500 MB storage limit. This is enough to get started with MongoDB Atlas. | ||
|
||
## Create a new cluster | ||
|
||
From the overview page, click on **+ Create**. | ||
|
||
<Screenshot url="https://cloud.mongodb.com" src="img/screenshots/20-mongodb-atlas/2-create-cluster/1-overview.png" alt="Overview screenshot" /> | ||
|
||
:::note | ||
If you just created your account, you will automatically be redirected to the cluster creation page and can skip this step. | ||
::: | ||
|
||
You will be redirected to the cluster creation page. Here you can choose the cloud provider and region where your data will be stored. You can also choose the type of cluster you want to create. For this tutorial, we will use the free tier. | ||
|
||
1. For the cluster tier, pick **M0**, which is the free tier. | ||
1. **Uncheck the _Automate security setup_ box.** You will set up security manually in the next steps. | ||
1. **Uncheck the _Preload sample dataset_ box.** You will import a dataset later in this lab. | ||
1. Select your favorite cloud provider and the region closest to you. | ||
1. Finally, click on **Create Deployment**. | ||
|
||
<Screenshot url="https://cloud.mongodb.com" src="img/screenshots/20-mongodb-atlas/2-create-cluster/2-deploy-database.png" alt="Create cluster screenshot" /> | ||
|
||
## Security quickstart | ||
|
||
By default, your MongoDB Atlas deployment is completely locked down. You need to configure the network settings and create a user to access your database. | ||
|
||
While your deployment is being provisioned, you will see the security quickstart dialog. | ||
|
||
### Network access | ||
|
||
First, you need to **Allow Access from Anywhere**. You will see a field prepopulated with the IP address `0.0.0.0/0`. This means that you can connect to your database from any IP address, including the virtual environment you will use for this lab. | ||
|
||
Click **Add IP Address** to add it to the network allowlist. | ||
|
||
:::note | ||
If you don't see a button to allow access from anywhere, you should close the dialog and go to the **Network Access** tab under the **Security** section in the left sidebar. Click on **Add IP Address**, add `0.0.0.0/0`, and click **Confirm**. | ||
::: | ||
|
||
:::caution | ||
It is dangerous to expose your database to the entire world. Never do this in a real production environment. | ||
::: | ||
|
||
### Database user | ||
|
||
Next, you need to create a database user. Pick any username and password you want. They will be used when you want to connect to your database. Click **Create Database User** to create the user. | ||
|
||
Atlas might create the user automatically for you if you have just created your account. In this case, the username and password will match your Atlas account credentials. | ||
|
||
:::tip | ||
Make sure to remember your username and password. You will need them later. | ||
|
||
For the sake of this workshop, it might be preferable to use a simple password that you'll remember over a more secure one. | ||
|
||
<strong>Don't use any special characters in your password</strong>. Even though MongoDB allows some special characters, they might not work well with the tools you'll use later in this workshop. | ||
::: | ||
|
||
## That's all! | ||
|
||
That's all! You now have a new database cluster. If everything goes well, you should see your newly created cluster on the **Overview** page. | ||
|
||
<Screenshot url="https://cloud.mongodb.com" src="img/screenshots/20-mongodb-atlas/2-create-cluster/3-database-deployment.png" alt="Create cluster screenshot" /> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,27 @@ | ||
import Screenshot from "@site/src/components/Screenshot"; | ||
|
||
# 👐 Get your connection string | ||
|
||
To connect to your cluster later on, you will need to get the connection string for your cluster. | ||
|
||
In the Atlas UI, navigate to the **Overview** page. In the **Clusters section**, select your cluster and click **Connect**. | ||
|
||
<Screenshot url="https://cloud.mongodb.com" src="img/screenshots/20-mongodb-atlas/3-connection-string/1-connect-button.png" alt="Connect button" /> | ||
|
||
A modal will display several ways to connect to your database. Select **Drivers**. | ||
|
||
<Screenshot url="https://cloud.mongodb.com" src="img/screenshots/20-mongodb-atlas/3-connection-string/2-connect-modal.png" alt="Connect modal" /> | ||
|
||
Look for your connection string. It should look something like this: | ||
|
||
``` | ||
mongodb+srv://<username>:<password>@<cluster-url>/?retryWrites=true&w=majority&appName=Cluster0 | ||
``` | ||
|
||
<Screenshot url="https://cloud.mongodb.com" src="img/screenshots/20-mongodb-atlas/3-connection-string/3-connection-string.png" alt="Get connection string" /> | ||
|
||
Click the copy button next to your connection string to copy it to your clipboard. Paste the connection string somewhere safe. You will need this connection string several times throughout this training. | ||
|
||
:::tip | ||
Don't forget to replace `<db_password>` with the password you set when you created the cluster. | ||
::: |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
{ | ||
"label": "MongoDB Atlas", | ||
"position": 20, | ||
"link": { | ||
"type": "generated-index", | ||
"description": "Create a MongoDB Atlas account and deploy a free cluster" | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
{ | ||
"label": "Dev Environment", | ||
"position": 30, | ||
"link": { | ||
"type": "generated-index", | ||
"description": "Setup the dev environment and prerequisites" | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
{ | ||
"label": "Import Data", | ||
"position": 40, | ||
"link": { | ||
"type": "generated-index", | ||
"description": "Import datasets into your MongoDB Atlas cluster" | ||
} | ||
} |
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
2 changes: 1 addition & 1 deletion
2
docs/30-agent-tools/_category_.json → docs/50-agent-tools/_category_.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
2 changes: 1 addition & 1 deletion
2
docs/40-create-agent/_category_.json → docs/60-create-agent/_category_.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
File renamed without changes.
2 changes: 1 addition & 1 deletion
2
docs/50-adding-memory/_category_.json → docs/70-adding-memory/_category_.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+55.6 KB
static/img/screenshots/20-mongodb-atlas/1-create-account/2-verify-email.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+122 KB
static/img/screenshots/20-mongodb-atlas/1-create-account/4-new-project.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+181 KB
static/img/screenshots/20-mongodb-atlas/1-create-account/5-new-project-name.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+40.4 KB
static/img/screenshots/20-mongodb-atlas/1-create-account/6-add-members.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+50.2 KB
static/img/screenshots/20-mongodb-atlas/2-create-cluster/1-overview.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+283 KB
static/img/screenshots/20-mongodb-atlas/2-create-cluster/2-deploy-database.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+146 KB
static/img/screenshots/20-mongodb-atlas/2-create-cluster/3-database-deployment.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+139 KB
static/img/screenshots/20-mongodb-atlas/3-connection-string/1-connect-button.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+254 KB
static/img/screenshots/20-mongodb-atlas/3-connection-string/2-connect-modal.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+271 KB
...ic/img/screenshots/20-mongodb-atlas/3-connection-string/3-connection-string.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes