You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@devlake.apache.org by kl...@apache.org on 2022/10/18 06:18:40 UTC
[incubator-devlake-website] branch main updated: Put webhook on internet (#272)
This is an automated email from the ASF dual-hosted git repository.
klesh pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/incubator-devlake-website.git
The following commit(s) were added to refs/heads/main by this push:
new be3d6b762 Put webhook on internet (#272)
be3d6b762 is described below
commit be3d6b7625fe3e5ea715964ec2c2edbcec9d575f
Author: Hezheng Yin <he...@merico.dev>
AuthorDate: Mon Oct 17 23:18:35 2022 -0700
Put webhook on internet (#272)
* docs: update add new webhook section
* docs: move webhook accessibility section to webhook plugin doc
---
docs/Plugins/webhook.md | 12 +++++++++++-
docs/UserManuals/ConfigUI/webhook.md | 10 ----------
2 files changed, 11 insertions(+), 11 deletions(-)
diff --git a/docs/Plugins/webhook.md b/docs/Plugins/webhook.md
index 897de7a1b..509babef1 100644
--- a/docs/Plugins/webhook.md
+++ b/docs/Plugins/webhook.md
@@ -20,10 +20,20 @@ To add a new webhook, go to the "Data Connections" page in config-ui and select
We recommend that you give your webhook connection a unique name so that you can identify and manage where you have used it later.
-After clicking on the "Generate POST URL" button, you will find four webhook URLs. Copy the ones that suit your usage into your CI or issue tracking systems. You can always come back to the webhook page to copy the URLs later on.
+After clicking on the "Generate POST URL" button, you will find several webhook URLs. You can then post to these URLs from your CI/CD tool or issue tracking system to push data directly to DevLake. You can always come back to the webhook page to access the URLs later.
+### Put webhook on the internet
+
+For the new webhook to work, it needs to be accessible from the DevOps tools from which you would like to push data to DevLake. If DevLake is deployed in your private network and your DevOps tool (e.g. CircleCI) is a cloud service that lives outside of your private network, then you need to make DevLake's webhook accessible to the outside cloud service.
+
+There're many tools for this:
+
+ - For testing and quick setup, [ngrok](https://ngrok.com/) is a useful utility that provides a publicly accessible web URL to any locally hosted application. You can put DevLake's webhook on the internet within 5 mins by following ngrok's [Getting Started](https://ngrok.com/docs/getting-started) guide. Note that, when posting to webhook, you may need to replace the `localhost` part in the webhook URL with the forwarding URL that ngrok provides.
+ - If you prefer DIY, please checkout open-source reverse proxies like [fatedier/frp](https://github.com/fatedier/frp) or go for the classic [nginx](https://www.nginx.com/).
+
+
## Register a deployment
You can copy the generated deployment curl commands to your CI/CD script to post deployments to Apache DevLake. Below is the detailed payload schema:
diff --git a/docs/UserManuals/ConfigUI/webhook.md b/docs/UserManuals/ConfigUI/webhook.md
index d349d4d3a..7b47e9013 100644
--- a/docs/UserManuals/ConfigUI/webhook.md
+++ b/docs/UserManuals/ConfigUI/webhook.md
@@ -18,13 +18,3 @@ After clicking on "Generate POST URL", you will find four webhook URLs. Copy the
For more usage: [plugins/webhook](/Plugins/webhook.md).
-
-
-### Webhook Accessibility
-
-In real-world scenarios, most likely, you would like to call the webhook API from another machine inside some CI/CD scripts. The CI/CD Machine may be located in the same Internal Network or provided by a Cloud Service.
-
-In any case, the only rule is to make sure the CI/CD Machine could reach the config-ui instance.
-
- - Access the config-ui via IP Address or Domain Name that is accessible from the CI/CD Machine, since the Webhook FQDN is generated based on the Browser URL. In other words, `localhost` and `127.0.0.1` might not work.
- - If you set up Apache DevLake as [Internal Deployment](../Authentication#internal-deployment-recommended) and the CI/CD Machine belongs to a Cloud Service Provider, you may have to switch to `Internet Deployment` or employ reverse-proxy software like [fatedier/frp](https://github.com/fatedier/frp).