Skip to content

Commit 879ed5b

Browse files
Anthony Sansonei80and
Anthony Sansone
authored and
i80and
committed
Add New User Information
1 parent 1eee3ae commit 879ed5b

9 files changed

+696
-0
lines changed

‎source/includes/steps-configure-git.yaml

Lines changed: 113 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,113 @@
1+
title: "Fork these repositories into your own GitHub account. +"
2+
stepnum: 1
3+
ref: fork-repos
4+
content: |
5+
6+
`This guide from GitHub <https://guides.github.com/activities/forking/>`_ covers the specifics.
7+
8+
- https://github.com/mongodb/docs
9+
- https://github.com/mongodb/docs-ecosystem
10+
- https://github.com/mongodb/docs-primer
11+
- https://github.com/mongodb/docs-assets
12+
- https://github.com/mongodb/docs-tools
13+
- https://github.com/10gen/mms-docs
14+
- https://github.com/10gen/cloud-docs
15+
- https://github.com/mongodb/docs-bi-connector
16+
---
17+
title: "Clone and prepare MongoDB Documentation Assets."
18+
stepnum: 2
19+
ref: clone-docs-assets
20+
pre: |
21+
22+
action:
23+
language: sh
24+
code: |
25+
git clone [email protected]:<yourid>/docs-assets.git
26+
cd docs-assets
27+
git remote add upstream [email protected]:mongodb/docs-assets.git
28+
---
29+
title: "Clone and prepare MongoDB Documentation Toolset."
30+
stepnum: 3
31+
ref: prep-docs-tools
32+
pre: |
33+
34+
action:
35+
language: sh
36+
code: |
37+
git clone [email protected]:<yourid>/docs-tools.git
38+
cd docs-tools
39+
git remote add upstream [email protected]:mongodb/docs-tools.git
40+
---
41+
title: "Clone and prepare MongoDB Manual documentation."
42+
stepnum: 4
43+
ref: clone-docs
44+
pre: |
45+
46+
action:
47+
language: sh
48+
code: |
49+
git clone [email protected]:<yourid>/docs.git
50+
cd docs
51+
giza generate assets
52+
git remote add upstream [email protected]:mongodb/docs.git
53+
---
54+
title: "Clone and prepare MongoDB Primer documentation."
55+
stepnum: 5
56+
ref: clone-docs-primer
57+
pre: |
58+
59+
action:
60+
language: sh
61+
code: |
62+
git clone [email protected]:<yourid>/docs-primer.git
63+
cd docs-primer
64+
git remote add upstream [email protected]:mongodb/docs-primer.git
65+
---
66+
title: "Clone and prepare the Cloud/Ops Manager documentation."
67+
stepnum: 6
68+
ref: clone-mms-docs
69+
pre: |
70+
71+
action:
72+
language: sh
73+
code: |
74+
git clone [email protected]:<yourid>/mms-docs.git
75+
cd mms-docs
76+
git remote add upstream [email protected]:10gen/mms-docs.git
77+
---
78+
title: "Clone and prepare the Atlas documentation."
79+
stepnum: 7
80+
ref: clone-cloud-docs
81+
pre: |
82+
83+
action:
84+
language: sh
85+
code: |
86+
git clone [email protected]:<yourid>/cloud-docs.git
87+
cd cloud-docs
88+
git remote add upstream [email protected]:10gen/cloud-docs.git
89+
---
90+
title: "Clone and prepare the BI Connector documentation."
91+
stepnum: 8
92+
ref: clone-bi-docs
93+
pre: |
94+
95+
action:
96+
language: sh
97+
code: |
98+
git clone [email protected]:<yourid>/docs-bi-connector.git
99+
cd docs-bi-connector
100+
git remote add upstream [email protected]:10gen/docs-bi-connector.git
101+
---
102+
title: "If you want to be able to work from a local development copy of giza (optional):"
103+
stepnum: 9
104+
ref:
105+
pre: |
106+
107+
action:
108+
language: sh
109+
code: |
110+
sudo pip uninstall giza
111+
cd docs-tools/giza
112+
sudo python ./setup.py develop
113+
...

‎source/includes/steps-create-ssh-key.yaml

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
title: "Generate the certificate and follow the prompts. "
2+
stepnum: 1
3+
ref: generate-certificates
4+
pre: |
5+
When you are asked to name the file, you must provide the full path as well.
6+
Otherwise, press enter when asked to name the file or else the ``.ssh``
7+
directory may not be created.
8+
action:
9+
language: sh
10+
code: |
11+
ssh-keygen -t rsa -b 4096 -C "[email protected]"
12+
---
13+
title: "Set the certificate permissions."
14+
stepnum: 2
15+
ref: set-cert-perms
16+
pre: |
17+
Change to the default user directory for SSH certificates. Change the
18+
permissions for the certificate to owner read/write only.
19+
action:
20+
language: sh
21+
code: |
22+
cd ~/.ssh/
23+
chmod 600 <name>.pub
24+
---
25+
title: "Enable SSH password management."
26+
stepnum: 3
27+
ref: enable-ssh-passwords
28+
pre: |
29+
This is supposed to be enabled by default on MacOS X systems.
30+
action:
31+
language: sh
32+
code: |
33+
eval ``ssh-agent``
34+
---
35+
title: "Add your certificate to the SSH password manager."
36+
stepnum: 4
37+
ref: add-cert-to-ssh
38+
pre: |
39+
action:
40+
language: sh
41+
code: |
42+
ssh-add
43+
post: "Enter the password for the certificate."
44+
---
45+
title: "Add this certificate to your GitHub account."
46+
stepnum: 5
47+
ref: add-cert-to-github
48+
content: |
49+
For specific instructions, see
50+
`GitHub <https://help.github.com/articles/adding-a-new-ssh-key-to-your-github-account/>`_.
51+
...

‎source/includes/steps-get-aws-keys.yaml

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
title: "Login to your AWS Account."
2+
stepnum: 1
3+
ref: login-aws
4+
content: |
5+
Login to `AWS for the Education department <https://idp.mongodb.com/simplesaml/saml2/idp/SSOService.php?spentityid=urn:amazon:webservices:univ-training-991734710418>`_.
6+
7+
---
8+
title: "Connect to your AWS Instance."
9+
stepnum: 2
10+
ref: connect-aws-instance
11+
content: |
12+
13+
a. After you have `created an instance
14+
<https://gist.github.com/atsansone/52e63e3f22811adcc8b6#create-an-aws-instance>`_,
15+
click on radio button for your instance.
16+
17+
b. Click :guilabel:`Connect`.
18+
19+
---
20+
title: "Choose or create an SSH Key (if needed)."
21+
stepnum: 3
22+
ref: create-ssh-key
23+
content: |
24+
25+
If this is your first time connecting to this instance, EC2 asks if you want
26+
to use an existing key file or create a new one.
27+
28+
If you need to create a new key file, click :guilabel:`Create New Key`. A
29+
new key downloads to your computer.
30+
31+
---
32+
title: "Copy this key file to your SSH certificate directory."
33+
stepnum: 4
34+
ref: copy-ssh-key
35+
pre: |
36+
action:
37+
language: sh
38+
code: |
39+
cp yourawscert.pem ~/.ssh/
40+
---
41+
title: "Change the ownership of this key file."
42+
stepnum: 5
43+
ref: update-key-permissions
44+
pre: |
45+
The key file must only be readable by you.
46+
action:
47+
language: sh
48+
code: |
49+
chmod 600 ~/.ssh/yourawscert.pem
50+
...

‎source/includes/steps-install-aws-keys.yaml

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
title: "Login to Cloud Manager."
2+
stepnum: 1
3+
ref: login-cloud-manager-1
4+
5+
---
6+
title: "Set billing information."
7+
stepnum: 2
8+
ref: set-billing
9+
content: |
10+
11+
a. Create a new Group.
12+
13+
b. Click `Settings`.
14+
15+
c. Click `Billing/Subscriptions`.
16+
17+
d. Click :guilabel:`Pencil Icon` to the right of :guilabel:`Payment Method`
18+
to activate your account.
19+
20+
e. Use `Stripe's Test Cards <https://stripe.com/docs/testing>`_ to
21+
complete your payment setup.
22+
23+
---
24+
title: "Complete the AWS Configuration."
25+
stepnum: 3
26+
ref: create-aws-config
27+
content: |
28+
29+
a. Click :guilabel:`Provisioning Settings`.
30+
31+
b. Click :guilabel:`Add Providers`.
32+
33+
c. Select :guilabel:`Add AWS Configuration`.
34+
35+
d. Complete the AWS configuration fields:
36+
37+
.. list-table::
38+
:widths: 20 80
39+
:header-rows: 1
40+
41+
* - Field
42+
- Action
43+
44+
* - Authentication Method
45+
- Choose `Access Key/Secret`.
46+
47+
* - Access Key ID
48+
- Enter the Access Key that |automationperson| gave you.
49+
50+
* - Secret Access Key
51+
- Enter the Secret Access Key that |automationperson| gave you.
52+
53+
* - Region
54+
- Select or type a region. The default of ``us-east-1`` is fine.
55+
56+
* - Machine Username
57+
- Type the username you want to use to login to AWS servers
58+
via SSH.
59+
60+
* - MongoDB Data Directory
61+
- Set the path to the MongoDB databases that Cloud creates.
62+
The default of ``/data`` is allowed.
63+
64+
---
65+
title: "Click :guilabel:`Add`."
66+
stepnum: 4
67+
ref: click-add
68+
69+
...

‎source/includes/steps-install-noc-keys.yaml

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
title: "Create a giza AWS configuration file in your home config directory."
2+
stepnum: 1
3+
ref: create-aws-config
4+
pre: |
5+
6+
action:
7+
language: sh
8+
code: |
9+
mkdir -m 755 -p ~/.config
10+
vi ~/.config/giza-aws-authentication.conf
11+
12+
---
13+
title: "Add an ``[authentication]`` block in your configuration file."
14+
stepnum: 2
15+
ref: add-auth-block
16+
pre: |
17+
18+
action:
19+
language: ini
20+
code: |
21+
[authentication]
22+
accesskey=<AABBCCDDEEFFGGHHIIJJ>
23+
secretkey=<aBcD+eFgHiJkLmNoP+qRsTuVwXyZAbCdEfGhIjKl>
24+
post: |
25+
``accesskey`` and ``secretkey`` are the values from the AWS credentials
26+
that |automationperson| gave you for ``noc-prod``.
27+
28+
---
29+
title: "Save your configuration file."
30+
stepnum: 3
31+
ref: save-aws-config-file
32+
33+
---
34+
title: "Set this file to be owner readable."
35+
stepnum: 4
36+
ref: make-owner-readable
37+
pre: |
38+
39+
action:
40+
language: sh
41+
code: |
42+
chmod 600 ~/.config/giza-aws-authentication.conf
43+
...

0 commit comments

Comments
 (0)