mirror of
https://github.com/Start9Labs/documentation.git
synced 2026-03-26 10:21:53 +00:00
remove assets and add backups to service dev docs
This commit is contained in:
29
source/contributing/services/backups.rst
Normal file
29
source/contributing/services/backups.rst
Normal file
@@ -0,0 +1,29 @@
|
||||
.. _service_backups:
|
||||
|
||||
***************
|
||||
Service Backups
|
||||
***************
|
||||
|
||||
Everything within the root of the mounted volume directory will be stored in an EmbassyOS backup. This includes the config (config.yaml) and properties (stats.yaml) files, as well as any other persisted data within the volume directory.
|
||||
|
||||
For restoration purposes, it might be beneficial to ignore certain files or folders. For instance, ignore the shared/public folder that is mounted for dependencies that expose this feature as it causes data inconsistencies on restore.
|
||||
|
||||
In this case, create a `.backupignore` file. This file contains a list of relative paths to the ignored files.
|
||||
|
||||
|
||||
Example
|
||||
=======
|
||||
|
||||
The `btcpayserver wrapper <https://github.com/Start9Labs/btcpayserver-wrapper/blob/master/configurator/src/templates/.backupignore.templates>`_ demonstrates a good use of a backupignore template.
|
||||
|
||||
Ultimately, ``/datadir/.backupignore`` gets populated with:
|
||||
|
||||
.. code::
|
||||
|
||||
/root/volumes/btcpayserver/start9/public
|
||||
/root/volumes/btcpayserver/start9/shared
|
||||
|
||||
.. role:: raw-html(raw)
|
||||
:format: html
|
||||
|
||||
:raw-html:`<br />`
|
||||
@@ -31,6 +31,7 @@ Happy building!
|
||||
Config <config>
|
||||
Properties <properties>
|
||||
Instructions <instructions>
|
||||
Backups <backups>
|
||||
|
||||
Submission process
|
||||
------------------
|
||||
|
||||
@@ -26,16 +26,12 @@ The project structure should be used as a model:
|
||||
├── Dockerfile
|
||||
├── Makefile (optional)
|
||||
├── README.md
|
||||
├── assets
|
||||
│ ├── httpd.conf (optional)
|
||||
│ └── httpd.conf.template (optional)
|
||||
├── config_rules.yaml
|
||||
├── config_spec.yaml
|
||||
├── <submodule_project_dir>
|
||||
├── docker_entrypoint.sh
|
||||
├── docs
|
||||
│ └── instructions.md
|
||||
├── instructions.md -> docs/instructions.md (symlink)
|
||||
└── manifest.yaml
|
||||
|
||||
Submodule
|
||||
@@ -43,20 +39,4 @@ Submodule
|
||||
|
||||
`Git sub-modules <https://www.git-scm.com/book/en/v2/Git-Tools-Submodules>`_ allow use of another project while in the working project directory. Setting up this feature enables linking of the source service repository so that it's context is available.
|
||||
|
||||
Run ``git submodule add <link_to_source_project>``
|
||||
|
||||
Assets
|
||||
======
|
||||
|
||||
.. warning::
|
||||
|
||||
*This section is being deprecated in favor of baking assets into the Docker image, and moved into the mountpoint at runtime if necessary*
|
||||
|
||||
Whenever a service is stopped, any file that is not contained within in the ``/assets`` directory will be cleared from memory. Any unsaved changes will be reverted. This folder acts as a persistance storage container.
|
||||
|
||||
In this folder belongs any assets that are unique configurations to your service. For instance, bitcoind's ``.conf`` file is saved here.
|
||||
|
||||
.. role:: raw-html(raw)
|
||||
:format: html
|
||||
|
||||
:raw-html:`<br />`
|
||||
Run ``git submodule add <link_to_source_project>``
|
||||
Reference in New Issue
Block a user