https://github.com/quickx-app/vultrdata

Service to return redacted metadata about the requesting instance itself.
https://github.com/quickx-app/vultrdata

instance instance-metadata metadata vultr vultr-api vultr-cli vultr-vps

Last synced: 2 months ago
JSON representation

Service to return redacted metadata about the requesting instance itself.

• Host: GitHub
• URL: https://github.com/quickx-app/vultrdata
• Owner: quickx-app
• License: mit
• Created: 2018-11-13T04:43:20.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2018-11-13T07:09:38.000Z (over 7 years ago)
• Last Synced: 2024-06-20T12:01:52.195Z (almost 2 years ago)
• Topics: instance, instance-metadata, metadata, vultr, vultr-api, vultr-cli, vultr-vps
• Language: Go
• Homepage:
• Size: 4.88 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# vultrdata

Service to return santized metadata about the requesting instance itself.

## Building

- Run `make deps build-linux`

The v1.0.0 release has a Linux 64-bit binary compiled with Go 1.11.2

## Installation

For systemd Linux systems:

- Create the directory /opt/vultrdata

- Copy `vultrdata-linux` to /opt/vultrdata/vultrdata

  (or copy the file named `vultrdata` if make run on a Linux system)

- Copy the file vultrdata.service to /etc/systemd/vultrdata.service

- Edit that vultrdata.service file changing the API_KEY value as well as listen addr/port and/or removing --userdata option

- On that system: `sudo systemctl daemon-reload`

- On that system: `sudo systemctl enable vultrdata`

- On that system: `sudo systemctl start vultrdata`

It is recommended that the listen address is chosen to be on the internal network for security. When instances are created with internal networking enabled it usually has an additional address starting with 10. or possibly some other non-routing range.

You may have to configure both the Vultr Firewall configuration as well as any firewall configured on the operating-system.

## Testing

- `curl -si 'http://10.1.1.1:8888/'`

  (Using whichever listen addr/port was chosen in vultrdata.service)

- Run the same command from another instance which should return data for that instance different than the first

- Log messages from the service go to `/var/log/syslog`