https://github.com/jsnjack/mech

Automate Constellix configuration
https://github.com/jsnjack/mech

configuration-management constellix dns infrastructure-as-code

Last synced: about 2 months ago
JSON representation

Automate Constellix configuration

• Host: GitHub
• URL: https://github.com/jsnjack/mech
• Owner: jsnjack
• License: other
• Created: 2022-11-03T20:28:20.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-07-06T10:09:43.000Z (7 months ago)
• Last Synced: 2024-07-06T11:26:11.767Z (7 months ago)
• Topics: configuration-management, constellix, dns, infrastructure-as-code
• Language: Go
• Homepage:
• Size: 8 MB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
mech

=======

`mech` automates Constellix DNS configuration (similar to [octodns](https://github.com/octodns/octodns)

and [terraform](https://www.terraform.io/)). The advantage of `mech` is that it

supports advanced configuration with multiple GTD regions and GeoProximity locations.

The application manages DNS records, Sonar checks and GeoProximity locations. The

functionality can easily be extended to support other Constellix resources.

# Supported features

> [Sonar REST API](https://api-docs.constellix.com/)

## Sonar

- [ ] static configuration

  - [x] http

  - [x] tcp

  - [ ] icmp

  - [ ] dns

  - [ ] ssl cert

- [ ] runtime data

  - [x] http

  - [ ] icmp

  - [ ] dns

  - [ ] tcp

  - [ ] ssl cert

## DNS

 - [ ] Domain records

   - [x] A

   - [x] AAAA

   - [x] ANAME

   - [ ] CAA

   - [ ] CERT

   - [x] CNAME

   - [ ] HINFO

   - [x] HTTP

   - [x] MX

   - [ ] NAPTR

   - [ ] NS

   - [ ] PTR

   - [ ] RP

   - [ ] SPF

   - [ ] SRV

   - [x] TXT

   - [ ] pools?

 - [x] GeoProximity

   - [ ] Renaming

# Configuration format

```

constellix:

  sonar:

    http_checks:

      - file1.yaml

      - file2.yaml

      - ...

    tcp_checks:

      - myfolder/*.yaml

  dns:

    surfly.gratis:

      - file4.yaml

```

> Use `mech sonar discover static -t http` command to print existing configuration

## Resource naming

Some of the resource (e.g. Sonar HTTP check ID in failover configuration) can be specified in 2 different ways:

 - ID of the resource, int

 - dynamically discovered value (e.g. `@sonar,http:test-online`). When parsing the configuration `mech` will call Constellix

   Sonar REST API and retrieve all available http checks. If one of the http checks has name `test-online`, it's ID will be

   used as `sonarCheckId`

# Resources

 - [Constellix DNS REST API v4](https://api.dns.constellix.com/v4/docs#tag/Domains)

 - [Constellix Sonar Rest API](https://api-docs.constellix.com/)

 - [Constellix go client](https://github.com/Constellix/constellix-go-client) (just for reference)