uptime-kuma icon indicating copy to clipboard operation
uptime-kuma copied to clipboard

Terraform Provider

Open pete-leese opened this issue 3 years ago • 13 comments

Hello,

Not really a feature request per-say, but I intend on building a terraform provider for those who wish to manage uptime kuma using terraform (IaC) which some may know is a popular tool when it comes to automation in the cloud / DevOps space.

This is of course dependant on an API is available - #118 and I hope that the terraform provider will closely follow any new feature added to the uptime kuma API.

I just wanted to let it be known my intentions and also to get an idea on if this will be of interest to others so I can priorise accordingly, please feel free to discuss / give a thumbs up if of interest to you !

Many thanks for a great product!

pete-leese avatar Aug 11 '21 21:08 pete-leese

Hi Pete, this is something that I would be very interested in seeing.

mikenabhan avatar Aug 23 '21 00:08 mikenabhan

I’ve created many Terraform providers, so I can help with it.

ondrejsika avatar Dec 29 '21 18:12 ondrejsika

Sounds great. Don’t think API support has been added yet until sometime in the 2.x.x lifecycle. Ready to rock when that does happen though.

pete-leese avatar Dec 29 '21 19:12 pete-leese

Any news on this one? It would be fantastic to be able to install services in kubernetes and register them in uptime kuma for monitoring.

Spritekin avatar Oct 14 '22 08:10 Spritekin

Any news on this one? It would be fantastic to be able to install services in kubernetes and register them in uptime kuma for monitoring.

Without API available, it's tricky :)

anthosz avatar Oct 14 '22 09:10 anthosz

There appears to be an unofficial API now as per https://github.com/louislam/uptime-kuma/issues/118#issuecomment-1205502024 and https://github.com/louislam/uptime-kuma/issues/118#issuecomment-1351710068

The relevant repos are:

  • for a python wrapper for the SocketIO API https://github.com/lucasheld/uptime-kuma-api
  • for a REST wrapper over it https://github.com/MedAziz11/Uptime-Kuma-Web-API

While these are not official APIs in the app itself, it doesn't seem likely that an official API will become available any time soon. A lot of people would love to use CI/CD friendly tools like terraform to maintain and control uptime-kuma. Until an official API becomes available, if ever, I believe these wrappers should be used instead.

@pete-leese and @ondrejsika What do you think?

Dragonatorul avatar Apr 07 '23 22:04 Dragonatorul

@ondrejsika maybe we can make one with the un-official API as metnioned above: https://github.com/MedAziz11/Uptime-Kuma-Web-API

Potentially we need a little confirmation for @MedAziz11 that he wants to keep it up to that if kuma revisits his structures or introduces breaking changes

vanhoutenbos avatar Jul 20 '23 12:07 vanhoutenbos

I'll try to create a PoC with that

ondrejsika avatar Aug 07 '23 16:08 ondrejsika

@ondrejsika maybe we can make one with the un-official API as metnioned above: https://github.com/MedAziz11/Uptime-Kuma-Web-API

Potentially we need a little confirmation for @MedAziz11 that he wants to keep it up to that if kuma revisits his structures or introduces breaking changes

Indeed, I am amenable to accommodating changes and fostering the project's ongoing development. However, I must express that I cannot commit to a high level of active engagement at this juncture due to my current constraints on available time. @vanhoutenbos

MedAziz11 avatar Aug 10 '23 10:08 MedAziz11

I’ve created many Terraform providers, so I can help with it.

Happy to help with this!

sachasmart avatar Dec 23 '23 05:12 sachasmart

I'm game to help as well, I've made a provider before as well

johntdyer avatar Apr 26 '24 18:04 johntdyer

See #3854 for the PR that the official REST API (which people above have said is a requirement for this instead of the semi-official python wrapper for the socket.io API)

We are currently working on #4500 which is a requirement befor this can happen. (If people want to get there quicker, please see this issue)

Maybe this can help: https://github.com/BigBoot/AutoKuma

CommanderStorm avatar Apr 26 '24 23:04 CommanderStorm

First thing when evaluating should I start using uptime Kuma was finding out if it has tf provider. Very interested in this.

AurimasNav avatar Aug 21 '24 06:08 AurimasNav