Skip to content

Commit d2d5ec5

Browse files
Revert "Merge pull request #100 from 10gen/charts-saas" (#101)
This reverts commit 15df507.
1 parent 15df507 commit d2d5ec5

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

49 files changed

+723
-1326
lines changed

Makefile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,4 +48,4 @@ screenshots:
4848
#node build/docs-tools/tools/screenshot-tool/screenshots.js `pwd`/screenshot-scripts/user-management.js
4949
#node build/docs-tools/tools/screenshot-tool/screenshots.js `pwd`/screenshot-scripts/movie-tutorial.js
5050
#node build/docs-tools/tools/screenshot-tool/screenshots.js `pwd`/screenshot-scripts/data-sources.js `pwd`/screenshot-scripts/.properties.ini
51-
node build/screencapture-tool/screenshots.js `pwd`/screenshot-scripts/data-table-dynamic.js `pwd`/screenshot-scripts/.properties.ini
51+
node build/screencapture-tool/screenshots.js `pwd`/screenshot-scripts/edit-chart-add-filter.js `pwd`/screenshot-scripts/.properties.ini

conf.py

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -60,8 +60,7 @@
6060
'.. |charts| replace:: MongoDB Charts',
6161
'.. |charts-short| replace:: Charts',
6262
'.. |checkmark| unicode:: U+2713',
63-
'.. |tls-ssl| replace:: :abbr:`TLS (Transport Layer Security)`/:abbr:`SSL (Secure Sockets Layer)`',
64-
'.. |service| replace:: Atlas'
63+
'.. |tls-ssl| replace:: :abbr:`TLS (Transport Layer Security)`/:abbr:`SSL (Secure Sockets Layer)`'
6564
]
6665

6766
rst_epilog.extend(get_replacements(conf))

config/sphinx_local.yaml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,6 @@ theme:
2121
- /tutorial/order-data/order-data-tutorial-overview
2222
- /tutorial/movie-details/movie-details-tutorial-overview
2323
- /chart-types
24-
- /customize-charts
2524
sidebars:
2625
'**':
2726
- 'pagenav.html'

screenshot-scripts/data-table-basic.js

Lines changed: 0 additions & 32 deletions
This file was deleted.

screenshot-scripts/data-table-dynamic.js

Lines changed: 0 additions & 32 deletions
This file was deleted.

source/administration.txt

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
==============
2+
Administration
3+
==============
4+
5+
.. default-domain:: mongodb
6+
7+
.. include:: /includes/toc/dfn-list-administration.rst
8+
9+
.. class:: hidden
10+
11+
.. toctree::
12+
:titlesonly:
13+
14+
/administration/backup-and-restore-keys
15+
/administration/configure-https-deployment
16+
/administration/configure-ssl-data-sources
17+
/administration/start-stop-charts
Lines changed: 84 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,84 @@
1+
=================================
2+
Back Up and Restore Security Keys
3+
=================================
4+
5+
.. default-domain:: mongodb
6+
7+
.. contents:: On this page
8+
:local:
9+
:backlinks: none
10+
:depth: 1
11+
:class: singlecol
12+
13+
.. include:: /includes/backup-restore-intro.rst
14+
15+
To prevent this from occurring, you should back up the encryption keys
16+
after the initial deployment and store them in a safe location. For a
17+
production Charts deployment you should also back up the data in the
18+
Charts metadata database using :manual:`MongoDB backup methods
19+
</core/backups>`.
20+
21+
Back Up Keys
22+
------------
23+
24+
.. include:: /includes/backup-keys.rst
25+
26+
Restore Keys
27+
------------
28+
29+
.. tabs::
30+
31+
tabs:
32+
33+
- id: windows
34+
name: Windows PowerShell
35+
content: |
36+
37+
To restore the keys on the host of the new Charts deployment, first
38+
copy the keys from the external location to the target host. For
39+
example, ``C:\temp\charts-keys-backup``. Then run the following commands
40+
before deploying |charts-short| from the docker-compose file:
41+
42+
.. code-block:: sh
43+
44+
docker volume create mongodb-charts_keys
45+
docker run -it `
46+
--volume mongodb-charts_keys:/volume `
47+
--volume /c/temp/charts-keys-backup:/backup `
48+
alpine sh -c 'cp /backup/* /volume'
49+
50+
.. include:: /includes/fact-docker-unix-paths-windows.rst
51+
52+
- id: macos
53+
name: macOS
54+
content: |
55+
56+
To restore the keys on the host of the new Charts deployment, first
57+
copy the keys from the external location to the target host. For
58+
example, ``/tmp/charts-keys-backup``. Then run the following commands
59+
before deploying |charts-short| from the docker-compose file:
60+
61+
.. code-block:: sh
62+
63+
docker volume create mongodb-charts_keys
64+
docker run -it \
65+
--volume mongodb-charts_keys:/volume \
66+
--volume /tmp/charts-keys-backup:/backup \
67+
alpine sh -c 'cp /backup/* /volume'
68+
69+
- id: linux
70+
name: Linux
71+
content: |
72+
73+
To restore the keys on the host of the new Charts deployment, first
74+
copy the keys from the external location to the target host. For
75+
example, ``/tmp/charts-keys-backup``. Then run the following commands
76+
before deploying |charts-short| from the docker-compose file:
77+
78+
.. code-block:: sh
79+
80+
docker volume create mongodb-charts_keys
81+
docker run -it \
82+
--volume mongodb-charts_keys:/volume \
83+
--volume /tmp/charts-keys-backup:/backup \
84+
alpine sh -c 'cp /backup/* /volume'
Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
========================================
2+
Configure Charts Web Server to Use HTTPS
3+
========================================
4+
5+
.. default-domain:: mongodb
6+
7+
.. contents:: On this page
8+
:local:
9+
:backlinks: none
10+
:depth: 1
11+
:class: singlecol
12+
13+
You can configure the |charts| web server to use the HTTPS
14+
protocol, as opposed to the default HTTP protocol. With the HTTPS
15+
protocol, the web server encrypts your data using
16+
:abbr:`SSL (Secure Socket Layer)`, which ensures that the host
17+
transmits data securely.
18+
19+
This process differs from :doc:`configuring SSL for data sources
20+
</administration/configure-ssl-data-sources>`, because this process
21+
enables |tls-ssl| on the |charts-short| web server itself, rather than
22+
configuring a connection to a specific MongoDB deployment with TLS/SSL
23+
enabled. When HTTPS is configured, |charts-short| uses the standard
24+
HTTPS port ``443`` by default, and the |charts-short| web server
25+
redirects any requests over HTTP (port 80) to the equivalent HTTPS
26+
port.
27+
28+
Prerequisites
29+
-------------
30+
31+
Before you can configure HTTPS for your |charts| web server, you must
32+
first obtain an SSL key and certificate from an appropriate
33+
certification authority. Instructions for obtaining an SSL key and
34+
providing a list of trusted certificate authorities are out of scope
35+
for this tutorial.
36+
37+
Procedure
38+
---------
39+
40+
To configure the |charts| web server to use the HTTPS protocol:
41+
42+
.. include:: /includes/steps/configure-https-for-charts.rst
Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
==================================
2+
Configure TLS/SSL for Data Sources
3+
==================================
4+
5+
.. default-domain:: mongodb
6+
7+
.. contents:: On this page
8+
:local:
9+
:backlinks: none
10+
:depth: 1
11+
:class: singlecol
12+
13+
|charts| can connect to MongoDB deployments running with or without
14+
|tls-ssl| enabled. If the deployment is running with TLS/SSL enabled,
15+
configuring your data source depends on whether the certificate is:
16+
17+
- signed by a trusted root certificate authority, or
18+
19+
- self-signed or issued by an internal certificate authority.
20+
21+
.. note::
22+
23+
MongoDB deployments should use |tls-ssl| 1.1 or later.
24+
25+
Certificate Signed by a Trusted Root CA
26+
---------------------------------------
27+
28+
To connect |charts-short| to a MongoDB deployment using a certificate
29+
signed by a trusted root certificate authority,
30+
:ref:`add a data source <add-data-source>` and append the ``ssl=true``
31+
option to the
32+
:manual:`Connection String URI </reference/connection-string>`:
33+
34+
.. include:: /includes/data-source-uri-ssl.rst
35+
36+
.. note::
37+
38+
No additional configuration is required when using a certificate
39+
signed by a trusted root certificate authority.
40+
41+
Self-Signed Certificate or Certificate Issued by an Internal CA
42+
---------------------------------------------------------------
43+
44+
To connect |charts-short| to a MongoDB deployment using a self-signed
45+
certificate or a certificate issued by an internal certificate
46+
authority, you must copy the certificate to the
47+
`Docker volume <https://docs.docker.com/storage/volumes/>`_. The
48+
following steps copy the certificate to the Docker volume, redeploy the
49+
|charts-short| application, and add a new data source configured to use
50+
|tls-ssl|:
51+
52+
.. include:: /includes/steps/copy-ssl-certs.rst
Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
=============================
2+
Start and Stop MongoDB Charts
3+
=============================
4+
5+
.. default-domain:: mongodb
6+
7+
.. contents:: On this page
8+
:local:
9+
:backlinks: none
10+
:depth: 1
11+
:class: singlecol
12+
13+
.. include:: /includes/start-stop-charts.rst

0 commit comments

Comments
 (0)