Salt Extension for Gandi

Manage Gandi.net from Salt, through its v5 REST API.

Covers four of Gandi's APIs behind one credential and one connection profile:

• LiveDNS -- zones, records, snapshots, DNSSEC keys, AXFR slaves and TSIG keys.
• Domain -- registration, renewal, transfers, nameservers, glue records, web redirections, tags, contacts and registry DNSSEC.
• Linked Zones -- one DNS zone shared across many domains.
• Billing -- account balance and catalogue prices.

Provides an execution module and a runner for each (the runner lets the master drive Gandi without pushing an account-wide token into minion pillar), plus states for the parts that make sense to manage declaratively, all supporting test=True.

salt '*' gandi_livedns.list_records example.com
salt-run gandi_domain.list_domains

www.example.com A record:
  gandi_livedns.record_present:
    - name: www
    - zone: example.com
    - type: A
    - ttl: 3600
    - values:
      - 192.0.2.1

Requires a personal access token from the Gandi admin interface. See the User Documentation for setup.

Security

Domain registration, renewal and restoration are deliberately not exposed as states: they spend money and are largely irreversible, so they stay execution module and runner functions where a human types the command. See Configuration for guidance on scoping tokens.

If you discover a security vulnerability, please refer to Salt's security guide.

If you discover a security vulnerability, please refer to Salt's security guide.

User Documentation

For setup and usage instructions, please refer to the User Documentation.

Contributing

The saltext-gandi project welcomes contributions from anyone!

The Salt Extensions guide provides comprehensive instructions on all aspects of Salt extension development, including writing tests, running tests, writing documentation and rendering the docs.

Quickstart

To get started contributing, first clone this repository (or your fork):

# Clone the repo
git clone --origin upstream git@gitlab.com:ggiesen/saltext-gandi.git

# Change to the repo dir
cd saltext-gandi

Automatic

If you have installed direnv, copying the included .envrc.example to .envrc and allowing it to run ensures a proper development environment is present and the virtual environment is active.

Without direnv, you can still run the automation explicitly:

make dev  # or python3 tools/initialize.py
source .venv/bin/activate

Manual

Please follow the first steps, skipping the repository initialization and first commit.

Ways to contribute

Contributions come in many forms, and they're all valuable! Here are some ways you can help without writing code:

• Documentation: Especially examples showing how to use this project to solve specific problems.
• Triaging issues: Help manage issues.

You can also contribute by:

• Writing blog posts
• Sharing your experiences using Salt + Gandi on social media
• Giving talks at conferences
• Publishing videos
• Engaging in IRC, Discord or email groups

Any of these things are super valuable to our community, and we sincerely appreciate every contribution!