Skip to content

Commit 669c4c6

Browse files
committed
Made sure the links in docs point to Clarified Security nova.core repo
1 parent e35f2b8 commit 669c4c6

35 files changed

Lines changed: 113 additions & 98 deletions

.ansible/.lock

Whitespace-only changes.

.github/workflows/mkdocs.yml

Lines changed: 17 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -32,33 +32,37 @@ jobs:
3232
build:
3333
runs-on: ubuntu-latest
3434
steps:
35-
- uses: actions/checkout@v3
35+
- uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
3636
with:
3737
fetch-depth: 1
38-
- uses: actions/checkout@v3
38+
- uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
3939
with:
4040
fetch-depth: 1
41-
repository: "ClarifiedSecurity/catapult"
42-
path: "catapult"
41+
repository: ClarifiedSecurity/catapult
42+
path: catapult
4343
token: ${{ secrets.TOKEN_CATAPULT_DOCS }}
44-
- uses: actions/checkout@v3
44+
- uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
4545
with:
4646
fetch-depth: 1
47-
repository: "ClarifiedSecurity/catapult-customizer"
48-
path: "catapult-customizer"
47+
repository: ClarifiedSecurity/catapult-customizer
48+
path: catapult-customizer
4949
token: ${{ secrets.TOKEN_CATAPULT_DOCS }}
50-
- uses: actions/checkout@v3
50+
- uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
5151
with:
5252
fetch-depth: 1
53-
repository: "ClarifiedSecurity/nova.core"
54-
path: "nova-core"
53+
repository: ClarifiedSecurity/nova.core
54+
path: nova-core
5555
token: ${{ secrets.TOKEN_CATAPULT_DOCS }}
5656
- run: rsync -avm --delete --include='*/' --include='*.md' --exclude='*' catapult/docs/ docs/catapult/
5757
- run: rsync -avm --delete --include='*/' --include='*.md' --exclude='*' catapult-customizer/ docs/catapult-customizer/
5858
- run: rsync -avm --delete --include='*/' --include='*.md' --exclude='*' nova-core/nova/core/roles/ docs/nova-core-collection/
59-
- run: find docs/nova-core-collection/ -type f -iname "*.md" -exec sh -c 'dir=$(dirname "$1"); parent=$(dirname "$dir"); base=$(basename "$dir"); mv "$1" "$parent/$base.md" ' sh {} \;
59+
- run:
60+
find docs/nova-core-collection/ -type f -iname "*.md" -exec sh -c 'dir=$(dirname "$1");
61+
parent=$(dirname "$dir"); base=$(basename "$dir"); mv "$1" "$parent/$base.md" ' sh {} \;
6062
- run: find docs/nova-core-collection/ -type d -depth -empty -exec rmdir {} \;
6163
- run: rm -rf catapult catapult-customizer nova-core
64+
- run: find docs/nova-core-collection/ -type f -exec
65+
sed -i 's|https://github.com/novateams/nova.core|https://github.com/ClarifiedSecurity/nova.core|g' {} \;
6266
- run: |
6367
git config --global user.name "CatapultBot"
6468
git config --global user.email "catapult@clarifiedsecurity.com"
@@ -68,24 +72,16 @@ jobs:
6872
git push -o ci.skip
6973
git status
7074
71-
### mk docs job
7275
docs:
7376
runs-on: ubuntu-latest
7477
needs: build
7578
steps:
76-
- uses: actions/checkout@v3
79+
- uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
7780
with:
7881
fetch-depth: 1
7982
- run: git fetch --all --depth=1 && git pull --all --rebase --depth=1
80-
- uses: actions/setup-python@v4
83+
- uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # v5.6.0
8184
with:
8285
python-version: 3.x
83-
#- run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV
84-
#- uses: actions/cache@v3
85-
# with:
86-
# key: mkdocs-material-${{ env.cache_id }}
87-
# path: .cache
88-
# restore-keys: |
89-
# mkdocs-material-
9086
- run: pip install mkdocs-material
9187
- run: mkdocs gh-deploy --force

docs/nova-core-collection/accounts.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ For most Unix based distributions `sudo` needs to be pre-installed.
2020

2121
## Role Variables
2222

23-
Refer to the [defaults/main.yml](https://github.com/novateams/nova.core/blob/main/nova/core/roles/accounts/defaults/main.yml) file for a list and description of the variables used in this role.
23+
Refer to the [defaults/main.yml](https://github.com/ClarifiedSecurity/nova.core/blob/main/nova/core/roles/accounts/defaults/main.yml) file for a list and description of the variables used in this role.
2424

2525
## Dependencies
2626

@@ -36,6 +36,15 @@ admin_accounts:
3636
- username: admin
3737
password: Password123
3838
ssh_key: ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIIB8J
39+
40+
- username: admin1
41+
password: Password123
42+
ssh_key: ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIIB8J
43+
update_password: on_create # This will update the password only when the account is created
44+
45+
- username: admin2
46+
ssh_key: ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIIB8J
47+
save_password_to_vault: false # This will not save a random generated the password to the vault, ssh is needed for authentication
3948
```
4049
4150
```yaml

docs/nova-core-collection/caddy.md

Lines changed: 22 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,11 @@ none
88

99
## Role Variables
1010

11-
Refer to the [defaults/main.yml](https://github.com/novateams/nova.core/blob/main/nova/core/roles/caddy/defaults/main.yml) file for a list and description of the variables used in this role.
11+
Refer to the [defaults/main.yml](https://github.com/ClarifiedSecurity/nova.core/blob/main/nova/core/roles/caddy/defaults/main.yml) file for a list and description of the variables used in this role.
1212

1313
## Dependencies
1414

15-
- Depends on Docker and Docker Compose being installed on the host. Docker can be installed using the [nova.core.docker](https://github.com/novateams/nova.core/tree/main/nova/core/roles/caddy) role.
15+
- Depends on Docker and Docker Compose being installed on the host. Docker can be installed using the [nova.core.docker](https://github.com/ClarifiedSecurity/nova.core/tree/main/nova/core/roles/caddy) role.
1616

1717
## Example
1818

@@ -57,3 +57,23 @@ Refer to the [defaults/main.yml](https://github.com/novateams/nova.core/blob/mai
5757
- www2.example.com
5858
caddy_server_reverse_proxy_to_address: http://internal.example.com
5959
```
60+
61+
```yaml
62+
# Installing Caddy server that has no configuration but API enabled from localhost for further configuration
63+
- name: Installing Caddy...
64+
ansible.builtin.include_role:
65+
name: nova.core.caddy
66+
vars:
67+
caddy_enable_api: true
68+
```
69+
70+
```yaml
71+
# Installing Caddy server that has no configuration but API enabled from everywhere for further configuration
72+
# Careful with this, as it allows anyone to access the Caddy API. The API port should be protected by a firewall.
73+
- name: Installing Caddy...
74+
ansible.builtin.include_role:
75+
name: nova.core.caddy
76+
vars:
77+
caddy_enable_api: true
78+
caddy_api_from_localhost_only: false
79+
```

docs/nova-core-collection/cleanup.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ none
88

99
## Role Variables
1010

11-
Refer to the [defaults/main.yml](https://github.com/novateams/nova.core/blob/main/nova/core/roles/cleanup/defaults/main.yml) file for a list and description of the variables used in this role.
11+
Refer to the [defaults/main.yml](https://github.com/ClarifiedSecurity/nova.core/blob/main/nova/core/roles/cleanup/defaults/main.yml) file for a list and description of the variables used in this role.
1212

1313
The `cleanup` role can be included in start.yml playbook by the `finalize` role. If `finalize_cleanup_system: true` is set in host or group vars, the cleanup role will be executed at the end of the playbook.
1414

docs/nova-core-collection/configure_networking.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# configure_networking
22

3-
This is a role to configure networking for a VM after cloning. Currently it is only supporting network configuration for VMs deployed on VMware vSphere, but the scripts are more or less universal and can be modified to add support to different hypervisors. [Here](https://github.com/novateams/nova.core/tree/main/nova/core/roles/configure_networking/tasks/vsphere) is a list of all supported network methods.
3+
This is a role to configure networking for a VM after cloning. Currently it is only supporting network configuration for VMs deployed on VMware vSphere, but the scripts are more or less universal and can be modified to add support to different hypervisors. [Here](https://github.com/ClarifiedSecurity/nova.core/tree/main/nova/core/roles/configure_networking/tasks/vsphere) is a list of all supported network methods.
44

55
## Requirements
66

@@ -14,7 +14,7 @@ The variable `customization_method` can take: `bsd`, `macos`, `netplan`, `networ
1414

1515
When selecting the network configuration method via the variable `customization_method`, if you are selecting `networkd` option, an extra variable is needed because this option can be used with different OS: `customization_method_distribution`. Possible options: `Debian`, `Archlinux`, `Scientific`
1616

17-
Refer to [defaults/main.yml](https://github.com/novateams/nova.core/blob/main/nova/core/roles/configure_networking/defaults/main.yml) for the full list of variables.
17+
Refer to [defaults/main.yml](https://github.com/ClarifiedSecurity/nova.core/blob/main/nova/core/roles/configure_networking/defaults/main.yml) for the full list of variables.
1818

1919
`extra_routes` - Can be set to add extra routes per interfaces. Supported only for `netplan`
2020

docs/nova-core-collection/configure_package_mirrors.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ none
1414

1515
## Role Variables
1616

17-
Refer to the [defaults/main.yml](https://github.com/novateams/nova.core/blob/main/nova/core/roles/template_os_configuration/defaults/main.yml) file for a list and description of the variables used in this role.
17+
Refer to the [defaults/main.yml](https://github.com/ClarifiedSecurity/nova.core/blob/main/nova/core/roles/template_os_configuration/defaults/main.yml) file for a list and description of the variables used in this role.
1818

1919
## Dependencies
2020

docs/nova-core-collection/connect.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ none
1010

1111
## Role Variables
1212

13-
Refer to [defaults/main.yml](https://github.com/novateams/nova.core/blob/main/nova/core/roles/connect/defaults/main.yml) for the full list of variables.
13+
Refer to [defaults/main.yml](https://github.com/ClarifiedSecurity/nova.core/blob/main/nova/core/roles/connect/defaults/main.yml) for the full list of variables.
1414

1515
## Dependencies
1616

docs/nova-core-collection/customization.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ none
88

99
## Role Variables
1010

11-
Refer to [defaults/main.yml](https://github.com/novateams/nova.core/blob/main/nova/core/roles/customization/defaults/main.yml) for the full list of variables.
11+
Refer to [defaults/main.yml](https://github.com/ClarifiedSecurity/nova.core/blob/main/nova/core/roles/customization/defaults/main.yml) for the full list of variables.
1212

1313
## Dependencies
1414

docs/nova-core-collection/customization_post_vm_role.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ none
88

99
## Role Variables
1010

11-
Refer to the [defaults/main.yml](https://github.com/novateams/nova.core/blob/main/nova/core/roles/customization_post_vm_role/defaults/main.yml) file for a list and description of the variables used in this role.
11+
Refer to the [defaults/main.yml](https://github.com/ClarifiedSecurity/nova.core/blob/main/nova/core/roles/customization_post_vm_role/defaults/main.yml) file for a list and description of the variables used in this role.
1212

1313
## Dependencies
1414

0 commit comments

Comments
 (0)