Merge pull request circleci#4636 from circleci/server/s3-lifecycle-guide

add S3 lifecycle page to docs site and PDF

Author: rosieyohannan

jekyll/_cci2/_ops-guide.adoc

@@ -58,4 +58,6 @@ include::customizations.adoc[]
 
 include::architecture.adoc[]
 
+include::storage-lifecycle.adoc[]
+
 :leveloffset: -1

jekyll/_cci2/storage-lifecycle.adoc

@@ -0,0 +1,84 @@
+= CircleCI Server AWS S3 Storage Lifecycle Guide
+:page-layout: classic-docs
+:page-liquid:
+:source-highlighter: rouge
+:rouge-linenums-mode: inline
+:icons: font
+:toc: macro
+:toc-title:
+:sectanchors:
+
+
+[.serveronly]_This document is intended for system administrators of self-hosted installations of CircleCI Server._
+
+This guide is intended to help system administrators of CircleCI Server installations on AWS better understand how S3 storage is used. This can help to cut compute resource costs and avoid issues for service users when removing resources. 
+
+In CircleCI Server, S3 Lifecycle policies are not configured automatically. The figures provided in this guide are examples to help you create a lifecycle policy for your installation. For more information on the steps required to add policy rules, see the https://docs.aws.amazon.com/AmazonS3/latest/user-guide/create-lifecycle.html[AWS Lifecycle Policy Guide].
+
+== Example Lifecycle Policy Configuration for S3 Buckets
+
+NOTE: Scroll table to the right to view all content.
+
+[.table.table-striped]
+[cols=5*, options="header", stripes=even]
+|===
+| **Prefix**
+| **Tag**
+| **Suggested Number of Days**
+| **Description of files**
+| **Side effects of deletion**
+
+| `artifacts` 
+| (null) 
+| 30 
+| General artifacts (deliverables from `store_artifacts` and `store_test_results`) 
+| Artifacts will disappear from the list of artifacts in job results. URLs will return 404. 
+
+| `artifacts` 
+| `"circleci.object_type" === "project.cache"` 
+| 15 
+| Dependency caches 
+| The first build after deletion will be slow due to cache miss.
+
+| `artifacts` 
+| `"circleci.object_type" === "workflow.workspace"` 
+| 15 
+| Workspaces 
+| If a job depending on workspaces is rerun (e.g. SSH rerun), `attach_workspace` will restore no files, and subsequent steps will fail. 
+
+| `artifacts/picard-task-configs` 
+| (null) 
+| 1 
+| Task config 
+| None
+
+| `action-logs` 
+| (null) 
+| 365 
+| Outputs from each step 
+| Outputs will not be shown any longer. Loading indicator will remain even after opening a pull-down for each step.
+
+| `cache` 
+| (null) 
+| 15 
+| Legacy cache 
+| This folder is not actively used. If a job depends on these files, the first build after deletion will be slow due to cache miss.
+|===
+
+[discrete]
+== Additional Locations Not Listed Above
+
+[discrete]
+=== `audit-logs`
+
+This is where audit logs are saved. Deleting this folder and files under this fodler has no impact on future operation of CircleCI, but deleted logs will be definitely lost and cannot be recovered.
+
+[discrete]
+=== `code-signing-keys`
+
+This is where signing keys for macOS/iOS apps are stored. This folder is no longer used actively.
+
+[discrete]
+=== `test-results`
+
+This is where statistic data collected with `store_test_results` resides. The data is used for future test splitting with `circleci tests split --split-by=timings`. **Deleting test results will cause CIRCLE BUG errors in future jobs using `parallelism`**.

jekyll/_data/sidenav.yml

@@ -321,7 +321,7 @@ en:
           link: 2.0/overview/
         - name: Nomad
           link: 2.0/nomad/
-        - name: Monitoring
+        - name: Metrics & Monitoring
           link: 2.0/monitoring/
         - name: Nomad Metrics
           link: 2.0/nomad-metrics/
@@ -359,6 +359,8 @@ en:
           link: 2.0/customizations/
         - name: Architecture
           link: 2.0/architecture/
+        - name: Storage Lifecycle
+          link: 2.0/storage-lifecycle/
         - name: Acknowledgments
           link: 2.0/open-source/
     - name: Server v2.19 PDFs