Skip to content

Commit

Permalink
Add changes for 56c3af5
Browse files Browse the repository at this point in the history
  • Loading branch information
actions-user committed Mar 8, 2024
1 parent a30d70b commit 6099b10
Show file tree
Hide file tree
Showing 30 changed files with 322 additions and 74 deletions.
26 changes: 19 additions & 7 deletions _sources/dev_process/project_docs.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -30,16 +30,24 @@ Edit the conf.py file similar to
Edit Documentation and View
=============================

Add documentation in the documentation directory. Organize in subdirectories where
logical.
Add documentation in the documentation directory.

Write all documents in ReStructured
Text or Markdown (The requirements-docs.txt should contain both sphinx and myst-parser
to handle each format. Organize in logical subdirectories.

Each document must contain only one top-level title, which will be displayed in the
Table of Contents. Any number of sub-level headings may be included in each document.

Edit the index.rst file to include page names under the Table of Contents (toctree).
These should include paths relative to the documentation directory, and filenames
without extension, similar to
`index.rst <../index.rst>`_.
without extension, similar to `index.rst <../index.rst>`_. The :maxdepth parameter
indicates how many sublevels will be displayed in the Table of Contents. Only if there
are very few pages should :maxdepth be more than 1.

In the documentation directory, run the following to build pages locally and check
formatting::
formatting. The command will build documentation and print errors and warnings
in the terminal output. Run this prior to pushing to Github::

make html

Expand Down Expand Up @@ -67,8 +75,12 @@ For Github Action, add YAML configuration files
Create a yaml file to initiate a github action with a file in ./.github/workflows, like
`build_sphinx_docs.yml <../../.github/workflows/build_sphinx_docs.yml>`_.

Optional?: Add `<.readthedocs.yaml <../../.readthedocs.yaml>`_ and
`environment.yml <../../environment.yml>`_ for the build.
TODO: test this after setup branch to publish from
------------------------------------------------------

Add `<.readthedocs.yaml <../../.readthedocs.yaml>`_ and
`environment.yml <../../environment.yml>`_ for the build. This will ensure that the
dependencies are installed and that index.html page will be the landing site.

Set Pages Site to branch created by Github action
--------------------------------------------------------
Expand Down
3 changes: 2 additions & 1 deletion _sources/index.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,6 @@ Welcome to Specify Developer documentation!
aws/aws_specify_cloud_setup
aws/client_migration_notes
aws/ec2_rds_specify7_setup
aws/aws_security
aws/specify_cloud_graviton_setup

.. toctree::
Expand All @@ -34,7 +33,9 @@ Welcome to Specify Developer documentation!
:maxdepth: 1
:caption: Security:

security/aws_security
security/fix_exposed_secret
security/monitoring

.. toctree::
:maxdepth: 1
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@ AWS Security
TODO:
========

Research
-------------------

Security best practices, including:

* role overview
Expand All @@ -14,6 +17,14 @@ Security best practices, including:
and access resources, so how best to deal with account numbers, usernames,
role names, secret names, domain names, bucket names, etc

Root user
------------------

* https://docs.aws.amazon.com/wellarchitected/latest/security-pillar/sec_securely_operate_aws_account.html
* MFA should be enabled on it
* only used for functions that require it
* Disable programmatic access
* Disallow creating of access keys for root account

References
==================
Expand Down
17 changes: 17 additions & 0 deletions _sources/security/monitoring.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
Security Monitoring
######################


GitGuardian
=====================

Account managed by Alec, Aimee, Grant, Max

Add organizations (lifemapper, biotaphy, specify, specifysystems) to Github integration

Check incidents, after determining that any risk is invalid, or has been revoked and
deleted, mark the incident as **Ignored** or **Resolved**.

Ignore repositories that we do not own (i.e. Max's)

Warnings are pushed to the Specify **updown-monitoring** Slack channel
3 changes: 2 additions & 1 deletion asset_server/asset_config_files.html
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,6 @@
<li class="toctree-l1"><a class="reference internal" href="../aws/aws_specify_cloud_setup.html">Specify Cloud Setup</a></li>
<li class="toctree-l1"><a class="reference internal" href="../aws/client_migration_notes.html">Digital Ocean to AWS migration</a></li>
<li class="toctree-l1"><a class="reference internal" href="../aws/ec2_rds_specify7_setup.html">Deploy Specify7 to an EC2 instance</a></li>
<li class="toctree-l1"><a class="reference internal" href="../aws/aws_security.html">AWS Security</a></li>
<li class="toctree-l1"><a class="reference internal" href="../aws/specify_cloud_graviton_setup.html">Specify Cloud Graviton Setup</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Asset Server:</span></p>
Expand Down Expand Up @@ -80,7 +79,9 @@
</ul>
<p class="caption" role="heading"><span class="caption-text">Security:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../security/aws_security.html">AWS Security</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security/fix_exposed_secret.html">Fix Exposed Secrets</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security/monitoring.html">Security Monitoring</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Misc:</span></p>
<ul>
Expand Down
3 changes: 2 additions & 1 deletion asset_server/asset_server_config.html
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,6 @@
<li class="toctree-l1"><a class="reference internal" href="../aws/aws_specify_cloud_setup.html">Specify Cloud Setup</a></li>
<li class="toctree-l1"><a class="reference internal" href="../aws/client_migration_notes.html">Digital Ocean to AWS migration</a></li>
<li class="toctree-l1"><a class="reference internal" href="../aws/ec2_rds_specify7_setup.html">Deploy Specify7 to an EC2 instance</a></li>
<li class="toctree-l1"><a class="reference internal" href="../aws/aws_security.html">AWS Security</a></li>
<li class="toctree-l1"><a class="reference internal" href="../aws/specify_cloud_graviton_setup.html">Specify Cloud Graviton Setup</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Asset Server:</span></p>
Expand All @@ -69,7 +68,9 @@
</ul>
<p class="caption" role="heading"><span class="caption-text">Security:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../security/aws_security.html">AWS Security</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security/fix_exposed_secret.html">Fix Exposed Secrets</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security/monitoring.html">Security Monitoring</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Misc:</span></p>
<ul>
Expand Down
3 changes: 2 additions & 1 deletion asset_server/asset_server_setup.html
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,6 @@
<li class="toctree-l1"><a class="reference internal" href="../aws/aws_specify_cloud_setup.html">Specify Cloud Setup</a></li>
<li class="toctree-l1"><a class="reference internal" href="../aws/client_migration_notes.html">Digital Ocean to AWS migration</a></li>
<li class="toctree-l1"><a class="reference internal" href="../aws/ec2_rds_specify7_setup.html">Deploy Specify7 to an EC2 instance</a></li>
<li class="toctree-l1"><a class="reference internal" href="../aws/aws_security.html">AWS Security</a></li>
<li class="toctree-l1"><a class="reference internal" href="../aws/specify_cloud_graviton_setup.html">Specify Cloud Graviton Setup</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Asset Server:</span></p>
Expand All @@ -69,7 +68,9 @@
</ul>
<p class="caption" role="heading"><span class="caption-text">Security:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../security/aws_security.html">AWS Security</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security/fix_exposed_secret.html">Fix Exposed Secrets</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security/monitoring.html">Security Monitoring</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Misc:</span></p>
<ul>
Expand Down
3 changes: 2 additions & 1 deletion asset_server/hybrid_asset_server_setup.html
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,6 @@
<li class="toctree-l1"><a class="reference internal" href="../aws/aws_specify_cloud_setup.html">Specify Cloud Setup</a></li>
<li class="toctree-l1"><a class="reference internal" href="../aws/client_migration_notes.html">Digital Ocean to AWS migration</a></li>
<li class="toctree-l1"><a class="reference internal" href="../aws/ec2_rds_specify7_setup.html">Deploy Specify7 to an EC2 instance</a></li>
<li class="toctree-l1"><a class="reference internal" href="../aws/aws_security.html">AWS Security</a></li>
<li class="toctree-l1"><a class="reference internal" href="../aws/specify_cloud_graviton_setup.html">Specify Cloud Graviton Setup</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Asset Server:</span></p>
Expand All @@ -69,7 +68,9 @@
</ul>
<p class="caption" role="heading"><span class="caption-text">Security:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../security/aws_security.html">AWS Security</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security/fix_exposed_secret.html">Fix Exposed Secrets</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security/monitoring.html">Security Monitoring</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Misc:</span></p>
<ul>
Expand Down
3 changes: 2 additions & 1 deletion aws/aws_automation.html
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,6 @@
<li class="toctree-l1"><a class="reference internal" href="aws_specify_cloud_setup.html">Specify Cloud Setup</a></li>
<li class="toctree-l1"><a class="reference internal" href="client_migration_notes.html">Digital Ocean to AWS migration</a></li>
<li class="toctree-l1"><a class="reference internal" href="ec2_rds_specify7_setup.html">Deploy Specify7 to an EC2 instance</a></li>
<li class="toctree-l1"><a class="reference internal" href="aws_security.html">AWS Security</a></li>
<li class="toctree-l1"><a class="reference internal" href="specify_cloud_graviton_setup.html">Specify Cloud Graviton Setup</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Asset Server:</span></p>
Expand All @@ -72,7 +71,9 @@
</ul>
<p class="caption" role="heading"><span class="caption-text">Security:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../security/aws_security.html">AWS Security</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security/fix_exposed_secret.html">Fix Exposed Secrets</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security/monitoring.html">Security Monitoring</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Misc:</span></p>
<ul>
Expand Down
3 changes: 2 additions & 1 deletion aws/aws_infrastructure_notes.html
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,6 @@
<li class="toctree-l1"><a class="reference internal" href="aws_specify_cloud_setup.html">Specify Cloud Setup</a></li>
<li class="toctree-l1"><a class="reference internal" href="client_migration_notes.html">Digital Ocean to AWS migration</a></li>
<li class="toctree-l1"><a class="reference internal" href="ec2_rds_specify7_setup.html">Deploy Specify7 to an EC2 instance</a></li>
<li class="toctree-l1"><a class="reference internal" href="aws_security.html">AWS Security</a></li>
<li class="toctree-l1"><a class="reference internal" href="specify_cloud_graviton_setup.html">Specify Cloud Graviton Setup</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Asset Server:</span></p>
Expand All @@ -69,7 +68,9 @@
</ul>
<p class="caption" role="heading"><span class="caption-text">Security:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../security/aws_security.html">AWS Security</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security/fix_exposed_secret.html">Fix Exposed Secrets</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security/monitoring.html">Security Monitoring</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Misc:</span></p>
<ul>
Expand Down
3 changes: 2 additions & 1 deletion aws/aws_specify_asset_server_setup.html
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,6 @@
<li class="toctree-l1"><a class="reference internal" href="aws_specify_cloud_setup.html">Specify Cloud Setup</a></li>
<li class="toctree-l1"><a class="reference internal" href="client_migration_notes.html">Digital Ocean to AWS migration</a></li>
<li class="toctree-l1"><a class="reference internal" href="ec2_rds_specify7_setup.html">Deploy Specify7 to an EC2 instance</a></li>
<li class="toctree-l1"><a class="reference internal" href="aws_security.html">AWS Security</a></li>
<li class="toctree-l1"><a class="reference internal" href="specify_cloud_graviton_setup.html">Specify Cloud Graviton Setup</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Asset Server:</span></p>
Expand All @@ -75,7 +74,9 @@
</ul>
<p class="caption" role="heading"><span class="caption-text">Security:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../security/aws_security.html">AWS Security</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security/fix_exposed_secret.html">Fix Exposed Secrets</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security/monitoring.html">Security Monitoring</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Misc:</span></p>
<ul>
Expand Down
3 changes: 2 additions & 1 deletion aws/aws_specify_cloud_setup.html
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,6 @@
</li>
<li class="toctree-l1"><a class="reference internal" href="client_migration_notes.html">Digital Ocean to AWS migration</a></li>
<li class="toctree-l1"><a class="reference internal" href="ec2_rds_specify7_setup.html">Deploy Specify7 to an EC2 instance</a></li>
<li class="toctree-l1"><a class="reference internal" href="aws_security.html">AWS Security</a></li>
<li class="toctree-l1"><a class="reference internal" href="specify_cloud_graviton_setup.html">Specify Cloud Graviton Setup</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Asset Server:</span></p>
Expand All @@ -84,7 +83,9 @@
</ul>
<p class="caption" role="heading"><span class="caption-text">Security:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../security/aws_security.html">AWS Security</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security/fix_exposed_secret.html">Fix Exposed Secrets</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security/monitoring.html">Security Monitoring</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Misc:</span></p>
<ul>
Expand Down
3 changes: 2 additions & 1 deletion aws/client_migration_notes.html
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,6 @@
<li class="toctree-l1"><a class="reference internal" href="aws_specify_cloud_setup.html">Specify Cloud Setup</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Digital Ocean to AWS migration</a></li>
<li class="toctree-l1"><a class="reference internal" href="ec2_rds_specify7_setup.html">Deploy Specify7 to an EC2 instance</a></li>
<li class="toctree-l1"><a class="reference internal" href="aws_security.html">AWS Security</a></li>
<li class="toctree-l1"><a class="reference internal" href="specify_cloud_graviton_setup.html">Specify Cloud Graviton Setup</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Asset Server:</span></p>
Expand All @@ -69,7 +68,9 @@
</ul>
<p class="caption" role="heading"><span class="caption-text">Security:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../security/aws_security.html">AWS Security</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security/fix_exposed_secret.html">Fix Exposed Secrets</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security/monitoring.html">Security Monitoring</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Misc:</span></p>
<ul>
Expand Down
7 changes: 4 additions & 3 deletions aws/ec2_rds_specify7_setup.html
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
<script src="../_static/js/theme.js"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="AWS Security" href="aws_security.html" />
<link rel="next" title="Specify Cloud Graviton Setup" href="specify_cloud_graviton_setup.html" />
<link rel="prev" title="Digital Ocean to AWS migration" href="client_migration_notes.html" />
</head>

Expand Down Expand Up @@ -63,7 +63,6 @@
<li class="toctree-l2"><a class="reference internal" href="#concluding-notes">Concluding Notes</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="aws_security.html">AWS Security</a></li>
<li class="toctree-l1"><a class="reference internal" href="specify_cloud_graviton_setup.html">Specify Cloud Graviton Setup</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Asset Server:</span></p>
Expand All @@ -80,7 +79,9 @@
</ul>
<p class="caption" role="heading"><span class="caption-text">Security:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../security/aws_security.html">AWS Security</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security/fix_exposed_secret.html">Fix Exposed Secrets</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security/monitoring.html">Security Monitoring</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Misc:</span></p>
<ul>
Expand Down Expand Up @@ -417,7 +418,7 @@ <h2>Concluding Notes<a class="headerlink" href="#concluding-notes" title="Link t
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="client_migration_notes.html" class="btn btn-neutral float-left" title="Digital Ocean to AWS migration" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="aws_security.html" class="btn btn-neutral float-right" title="AWS Security" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
<a href="specify_cloud_graviton_setup.html" class="btn btn-neutral float-right" title="Specify Cloud Graviton Setup" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>

<hr/>
Expand Down
7 changes: 4 additions & 3 deletions aws/specify_cloud_graviton_setup.html
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="Specify 7 Docker Config Example" href="../asset_server/asset_config_files.html" />
<link rel="prev" title="AWS Security" href="aws_security.html" />
<link rel="prev" title="Deploy Specify7 to an EC2 instance" href="ec2_rds_specify7_setup.html" />
</head>

<body class="wy-body-for-nav">
Expand Down Expand Up @@ -52,7 +52,6 @@
<li class="toctree-l1"><a class="reference internal" href="aws_specify_cloud_setup.html">Specify Cloud Setup</a></li>
<li class="toctree-l1"><a class="reference internal" href="client_migration_notes.html">Digital Ocean to AWS migration</a></li>
<li class="toctree-l1"><a class="reference internal" href="ec2_rds_specify7_setup.html">Deploy Specify7 to an EC2 instance</a></li>
<li class="toctree-l1"><a class="reference internal" href="aws_security.html">AWS Security</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Specify Cloud Graviton Setup</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Asset Server:</span></p>
Expand All @@ -69,7 +68,9 @@
</ul>
<p class="caption" role="heading"><span class="caption-text">Security:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../security/aws_security.html">AWS Security</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security/fix_exposed_secret.html">Fix Exposed Secrets</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security/monitoring.html">Security Monitoring</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Misc:</span></p>
<ul>
Expand Down Expand Up @@ -512,7 +513,7 @@ <h1>Specify Cloud Graviton Setup<a class="headerlink" href="#specify-cloud-gravi
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="aws_security.html" class="btn btn-neutral float-left" title="AWS Security" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="ec2_rds_specify7_setup.html" class="btn btn-neutral float-left" title="Deploy Specify7 to an EC2 instance" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="../asset_server/asset_config_files.html" class="btn btn-neutral float-right" title="Specify 7 Docker Config Example" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>

Expand Down
Loading

0 comments on commit 6099b10

Please sign in to comment.