Skip to content

Commit

Permalink
readme
Browse files Browse the repository at this point in the history
  • Loading branch information
iljarotar committed Nov 26, 2024
1 parent 562acd1 commit 49588bc
Showing 1 changed file with 34 additions and 17 deletions.
51 changes: 34 additions & 17 deletions partition/roles/ztp/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,27 +2,11 @@

Configures a server for providing zero-touch-provisioning scripts for switches.

## Variables

| Name | Mandatory | Description |
| ---------------------------- | --------- | --------------------------------------------------------------------------------------------------------- |
| ztp_nginx_image_name | yes | the docker image to use to serve ztp scripts. |
| ztp_nginx_image_tag | yes | the tag of the docker image to use to serve ztp scripts. |
| ztp_host_dir_path | | the path to serve ztp scripts from. |
| ztp_listen_address | | the address used to serve ztp requests |
| ztp_port | | the port to serve ztp scripts on. |
| ztp_authorized_keys | yes | the authorized keys that should be installed by ztp. |
| ztp_admin_user | | the user for which the authorized keys will be provisioned. |
| ztp_additional_files | | puts additional files into serve directory. |
| ztp_sonic_nameservers | | the nameservers to put into resolv.conf for sonic |
| ztp_sonic_extended_cacl.ipv4 | | iptables ipv4 rules that should be added as extended Control Plane ACLs (Edgecore Sonic specific feature) |
| ztp_sonic_extended_cacl.ipv6 | | iptables ipv6 rules that should be added as extended Control Plane ACLs (Edgecore Sonic specific feature) |

## Provisioning SONiC Switches via ztp.json

On SONiC switches it is possible to describe the ZTP procedure in a file called `ztp.json`.
It contains all steps that should be performed during ZTP along with some additional options.
We use `ztp.json` to trigger a restart of the BGP service after the initial switch provisioning.
For example, host-specific download paths for the `config_db.json` or any additional files or scripts can be provided in the `ztp.json`.
To use the `ztp.json` file, add a DHCP option with code 67 to the DHCP server that serves the file.
For example, add a section like the following to `/etc/dhcp/dhcpd.conf`:

Expand All @@ -37,3 +21,36 @@ host leaf01 {
```

For more information on the `ztp.json` format refer to the [documentation](https://github.com/sonic-net/SONiC/blob/master/doc/ztp/ztp.md).

### Noteworthy

With a `ztp.json` file it is possible to provision a SONiC switch entirely via ZTP without using the `sonic` role.
To achieve this, some of the variables from the `sonic` role are reused in this role.
They are needed to render the templates for the `/etc/resolv.conf` and the `/etc/sonic/iptables.json`.
Note that each switch that uses the `ztp.json` file needs an individual `config_db.json`, that it can download at `http://{{ ztp_listen_address }}:{{ ztp_port }}/<hostname>_config_db.json`.
For example, if the switch's hostname is `r01leaf02`, there should be a file called `r01leaf02_config_db.json` located in `{{ ztp_host_dir_path }}/config/`.
The configs can be added to the `ztp_additional_files` variable, e.g.

```yaml
ztp_additional_files:
- name: r01leaf02_config_db.json
data: "{{ lookup('file', 'path/to/r01leaf02_config_db.json)' | string }}" # using `string` to keep the formatting
- name: r02leaf01_config_db.json
data: ...
```
## Variables
| Name | Mandatory | Description |
| ---------------------------- | --------- | --------------------------------------------------------------------------------------------------------- |
| ztp_nginx_image_name | yes | the docker image to use to serve ztp scripts. |
| ztp_nginx_image_tag | yes | the tag of the docker image to use to serve ztp scripts. |
| ztp_host_dir_path | | the path to serve ztp scripts from. |
| ztp_listen_address | | the address used to serve ztp requests |
| ztp_port | | the port to serve ztp scripts on. |
| ztp_authorized_keys | yes | the authorized keys that should be installed by ztp. |
| ztp_admin_user | | the user for which the authorized keys will be provisioned. |
| ztp_additional_files | | puts additional files into serve directory. |
| ztp_sonic_nameservers | | the nameservers to put into resolv.conf for sonic |
| ztp_sonic_extended_cacl.ipv4 | | iptables ipv4 rules that should be added as extended Control Plane ACLs (Edgecore Sonic specific feature) |
| ztp_sonic_extended_cacl.ipv6 | | iptables ipv6 rules that should be added as extended Control Plane ACLs (Edgecore Sonic specific feature) |

0 comments on commit 49588bc

Please sign in to comment.