Skip to content

Commit

Permalink
Adding-md
Browse files Browse the repository at this point in the history
  • Loading branch information
drazenCE committed Nov 29, 2024
1 parent 3f23647 commit d4b7796
Show file tree
Hide file tree
Showing 11 changed files with 58 additions and 2 deletions.
1 change: 1 addition & 0 deletions docs/_Sidebar.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@
- [Matomo](/roles/cache_clear/cache_clear-matomo)
- [Drupal 8](/roles/cache_clear/cache_clear-mautic)
- [Opcache](/roles/cache_clear/cache_clear-opcache)
- [Symfony](/roles/cache_clear/cache_clear-symfony)
- [ce-dev](/roles/ce_dev)
- [ce-dev prebuild](/roles/ce_dev/ce_dev_prebuild)
- [CLI Tools](/roles/cli)
Expand Down
14 changes: 14 additions & 0 deletions docs/roles/cache_clear/cache_clear-symfony.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# Symfony
Clears the Symfony application cache.
<!--TOC-->
<!--ENDTOC-->

<!--ROLEVARS-->
## Default variables
```yaml
---
cache_clear_symfony_env: prod

```
<!--ENDROLEVARS-->
3 changes: 3 additions & 0 deletions docs/roles/cron/cron_drupal7.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,11 +19,14 @@ drupal:
# month:
job: cron
# disabled: true
# mailto: "{{ drupal.cron_mailto | default('') }}" # Each cron can have it's own mailto and can be configured to use different e-mail addresses.
cron_mailto: ""
# If the sites are being deployed to an ASG, setting defer to true will create the crontab entry on the deploy server rather than all of the app servers.
defer: false
# If defer is set to true, the Ansible target must be declared with defer_target. If using a group, include the index. For example, _ce_www_dev[0]
defer_target: ""
drush_location: "{{ drush_bin }}" # you might specify another location, e.g. "{{ deploy_path }}/vendor/bin/drush"

```

<!--ENDROLEVARS-->
Expand Down
2 changes: 2 additions & 0 deletions docs/roles/cron/cron_drupal8.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@ drupal:
# month:
job: cron
# disabled: true
# mailto: "{{ drupal.cron_mailto | default('') }}" # Each cron can have it's own mailto and can be configured to use different e-mail addresses.
cron_mailto: ""
# If the sites are being deployed to an ASG, setting defer to true will create the crontab entry on the deploy server rather than all of the app servers.
defer: false
# If defer is set to true, the Ansible target must be declared with defer_target. If using a group, include the index. For example, _ce_www_dev[0]
Expand Down
8 changes: 8 additions & 0 deletions docs/roles/deploy_code.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,15 @@ Deploying code with autoscaling clusters relies on [cloud-init](https://cloudini
## Default variables
```yaml
---
# Required for NGINX config in feature branching.
_ce_provision_data_dir: /home/deploy/ce-deploy/data
deploy_code:
# Feature branching config.
feature_branch:
enabled: false
# NGINX domains to build, see ce-provision for docs: https://github.com/codeenigma/ce-provision/blob/2.x/roles/debian/nginx/defaults/main.yml#L133
domains: []
# Specify any additional symlink to create, with src (target) and dest (link).
# src: can be either absolute or relative to the dest (eg. '/var/my_data', '/home/deploy/simplesaml', '../../../myconfig')
# dest: can only be relative to the root of your repository (eg. 'www/themes/myassets', 'var/cache')
Expand Down
6 changes: 5 additions & 1 deletion docs/roles/sync/database_sync/database_sync-mysql.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,9 @@ mysql_sync:
credentials_file: "/home/{{ deploy_user }}/.mysql.creds"
# This can be of types:
# - rolling: (database backups). In that case we'll need build parameters.@todo
# - fixed: "fixed" database name
# - fixed: "fixed" database name # currently this var means the same as "dump"
# - dump: Use an existing dump. In that case, the "database" variable is the absolute file path.
# This parameter is ignored if var 'path_on_deploy_server' is defined.
type: fixed
# For "rolling builds", so we can compute the database name.
build_id: mybuildprod
Expand All @@ -37,6 +38,9 @@ mysql_sync:
dumps_directory: "/home/{{ deploy_user }}/shared/{{ project_name }}_{{ build_type }}/db_backups/mysql/regular"
# If the source is on an ASG, provide the ASG name here. Otherwise, leave empty.
asg: ""
# Uncomment and specify full path if you want to use your own dump file on the deploy server (gzip compressed).
# In this case it's the only variable you need in 'database.source'.
#path_on_deploy_server: "/home/{{ deploy_user }}/compressed_database_dump.gz"
target:
database: "{{ project_name }}_dev"
credentials_file: "/home/{{ deploy_user }}/.mysql.creds"
Expand Down
7 changes: 7 additions & 0 deletions roles/cache_clear/cache_clear-symfony/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,11 @@ Clears the Symfony application cache.
<!--ENDTOC-->

<!--ROLEVARS-->
## Default variables
```yaml
---
cache_clear_symfony_env: prod

```
<!--ENDROLEVARS-->
3 changes: 3 additions & 0 deletions roles/cron/cron_drupal7/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,11 +19,14 @@ drupal:
# month:
job: cron
# disabled: true
# mailto: "{{ drupal.cron_mailto | default('') }}" # Each cron can have it's own mailto and can be configured to use different e-mail addresses.
cron_mailto: ""
# If the sites are being deployed to an ASG, setting defer to true will create the crontab entry on the deploy server rather than all of the app servers.
defer: false
# If defer is set to true, the Ansible target must be declared with defer_target. If using a group, include the index. For example, _ce_www_dev[0]
defer_target: ""
drush_location: "{{ drush_bin }}" # you might specify another location, e.g. "{{ deploy_path }}/vendor/bin/drush"

```

<!--ENDROLEVARS-->
Expand Down
2 changes: 2 additions & 0 deletions roles/cron/cron_drupal8/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@ drupal:
# month:
job: cron
# disabled: true
# mailto: "{{ drupal.cron_mailto | default('') }}" # Each cron can have it's own mailto and can be configured to use different e-mail addresses.
cron_mailto: ""
# If the sites are being deployed to an ASG, setting defer to true will create the crontab entry on the deploy server rather than all of the app servers.
defer: false
# If defer is set to true, the Ansible target must be declared with defer_target. If using a group, include the index. For example, _ce_www_dev[0]
Expand Down
8 changes: 8 additions & 0 deletions roles/deploy_code/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,15 @@ Deploying code with autoscaling clusters relies on [cloud-init](https://cloudini
## Default variables
```yaml
---
# Required for NGINX config in feature branching.
_ce_provision_data_dir: /home/deploy/ce-deploy/data
deploy_code:
# Feature branching config.
feature_branch:
enabled: false
# NGINX domains to build, see ce-provision for docs: https://github.com/codeenigma/ce-provision/blob/2.x/roles/debian/nginx/defaults/main.yml#L133
domains: []
# Specify any additional symlink to create, with src (target) and dest (link).
# src: can be either absolute or relative to the dest (eg. '/var/my_data', '/home/deploy/simplesaml', '../../../myconfig')
# dest: can only be relative to the root of your repository (eg. 'www/themes/myassets', 'var/cache')
Expand Down
6 changes: 5 additions & 1 deletion roles/sync/database_sync/database_sync-mysql/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,9 @@ mysql_sync:
credentials_file: "/home/{{ deploy_user }}/.mysql.creds"
# This can be of types:
# - rolling: (database backups). In that case we'll need build parameters.@todo
# - fixed: "fixed" database name
# - fixed: "fixed" database name # currently this var means the same as "dump"
# - dump: Use an existing dump. In that case, the "database" variable is the absolute file path.
# This parameter is ignored if var 'path_on_deploy_server' is defined.
type: fixed
# For "rolling builds", so we can compute the database name.
build_id: mybuildprod
Expand All @@ -37,6 +38,9 @@ mysql_sync:
dumps_directory: "/home/{{ deploy_user }}/shared/{{ project_name }}_{{ build_type }}/db_backups/mysql/regular"
# If the source is on an ASG, provide the ASG name here. Otherwise, leave empty.
asg: ""
# Uncomment and specify full path if you want to use your own dump file on the deploy server (gzip compressed).
# In this case it's the only variable you need in 'database.source'.
#path_on_deploy_server: "/home/{{ deploy_user }}/compressed_database_dump.gz"
target:
database: "{{ project_name }}_dev"
credentials_file: "/home/{{ deploy_user }}/.mysql.creds"
Expand Down

0 comments on commit d4b7796

Please sign in to comment.