forked from mongodb/docs-relational-migrator
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathatlas-log-in.txt
99 lines (72 loc) · 2.69 KB
/
atlas-log-in.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
.. _rm-atlas-log-in:
=================
Log In with Atlas
=================
.. contents:: On this page
:local:
:backlinks: none
:depth: 1
:class: singlecol
You can optionally sign in to your Atlas account inside Relational
Migrator. If you log in, you can access the
:ref:`Query Converter <rm-query-converter>` feature and you can choose
destination clusters from a list when creating sync jobs.
Before you Begin
----------------
To log in with Atlas, you must have an existing :atlas:`Atlas account
</tutorial/create-atlas-account>`.
About this Task
---------------
- To log in with your Atlas account, Relational Migrator must be running
on localhost on one of the following ports:
- ``8278``
- ``8080``
- ``443``
- If you run Relational Migrator on any ports numbers other than the
ones listed above or if your accessing Relational Migrator from a
remote client, you will not be able to sign in to Atlas.
- You must reauthenticate when your session token expires. To
reauthenticate to your Atlas account, follow the same log in procedure
below.
- Depending on your Atlas login status the top-right profile section of
the Relational Migrator UI can change:
.. list-table::
:header-rows: 1
* - Login Status
- Profile Section UI
* - Signed Out
- Section shows a :guilabel:`Log In` button.
* - Logged In
- The section shows a button with the first letter of the
user's name.
* - Session expired
- The section shows a button with the first letter of the
user's name with a :icon-fa5:`exclamation`.
Steps
-----
.. procedure::
:style: normal
.. step:: Select a login option
On the top right of the Relational Migrator home screen, click
the profile icon or the :guilabel:`Log in` button. The account
login modal displays. Click the :icon-lg:`LogIn`
:guilabel:`Log in with Atlas` button.
.. tip::
You can also initiate the log in process from the
:guilabel:`Code Generation` tab by clicking the
:icon-lg:`LogIn` :guilabel:`Log in with Atlas` button on the
:guilabel:`Query Converter` pane.
.. step:: Enter your Atlas account credentials
Enter your :guilabel:`Email Address` and :guilabel:`Password`,
then click :guilabel:`Log in`.
.. step:: (Optional) Log out of Atlas account
Click on the profile icon on the top right and click
:icon-lg:`LogOut` :guilabel:`Log Out` to log out of your Atlas
account.
Next Steps
----------
- :ref:`rm-enable-query-converter`
- :ref:`rm-convert-queries`
Learn More
----------
- :atlas:`Create an Atlas Cluster </create-database-deployment/#clusters>`