API Gateway examples

[sounak-1989]

Hi guys,

I want to implement the API Gateway for my project. I am an embedded developer so I am not that great with Networking. If there is an example project with API Gateway configuration it would be great. I am trying to implement the instruction on the EdgeX website but the commands are failing.
When I try to implement the following command
docker-compose -p edgex -f docker-compose.yml run --rm -v pwd:/host:ro --entrypoint /edgex/secrets-config edgex-proxy proxy tls --incert /host/cert.pem --inkey /host/key.pem --snis edge001.example.com --admin_api_jwt /tmp/edgex/secrets/security-proxy-setup/kong-admin-jwt

I get
no such service: edgex-proxy

Need some help getting this up and running. Thanks

[bnevis-i]

The service in the docker-compose must have been renamed at some point. Use proxy-setup instead of edgex-proxy and see how that goes.

[sounak-1989]

I tried a bunch of different combinations including proxy-setup. But no luck.
I even tried the script upload-api-gateway-cert.sh with proper format and certificates that I generated using openssl. But it keeps giving me error saying the certificates are missing.
Stuck at this for a while now. Some help is much appreciated.
Thanks.

[sounak-1989]

Few observations and info while trying to implement security:
I am running my EdgeX on WSL inside windows.
I am running the latest image by using edgex-compose repository.

Things I have tried:

Running the script uplaod-api-gateway-cert.sh but no luck. Getting the following error
level=ERROR ts=2023-01-24T11:40:54.0750327Z app=secrets-config source=bootstraphandler.go:77 msg="failed to send request to list Kong snis tls certs: Get \"https://edgex-kong:8443/admin/snis\": dial tcp 172.24.0.6:8443: connect: connection refused"

Running the following command
docker-compose -p edgex -f docker-compose.yml run --rm -v pwd:/host:ro --entrypoint /edgex/secrets-config nexus3.edgexfoundry.org:10004/security-proxy-setup:latest proxy tls --incert /home/sdas/work/edgex_secty/edgex-compose/compose-builder/cert.pem --inkey /home/sdas/work/edgex_secty/edgex-compose/compose-builder/key.pem --snis edge001.example.com --admin_api_jwt /tmp/edgex/secrets/security-proxy-setup/kong-admin-jwt

Got the following response
no such service: nexus3.edgexfoundry.org:10004/security-proxy-setup:latest

On further inspection I found security-proxy-setup service has exited
This is how my docker looks like

I am a Firmware developer but I have taught myself stuff on need basis. With my limited knowledge of docker and other networking services like Kong. I am finding the documentation really scarce and outdated. Kindly help me out on this issue.
Thanks.

[lenny-goodell]

security-proxy-setup is a one shoot service, i.e. doesn't continue running. The container is suppose to stay up doing nothing, but will exit if the service has an error. Please post the logs from security-proxy-setup.

[sounak-1989]

Hi @lenny-intel,
Here's the log from the security-proxy-setup docker container.

Script for waiting security bootstrapping on proxy-setup
Tue Jan 24 11:33:22 UTC 2023 Executing waitFor for edgex-security-proxy-setup with waiting on   tcp://edgex-security-bootstrapper:54329
level=INFO ts=2023-01-24T11:33:22.8649394Z app=security-bootstrapper source=config.go:392 msg="Loaded service configuration from /edgex-init/res/configuration.toml"
level=INFO ts=2023-01-24T11:33:22.8654285Z app=security-bootstrapper source=variables.go:377 msg="Variables override of 'StageGate.KongDB.Host' by environment variable: STAGEGATE_KONGDB_HOST=edgex-kong-db"
level=INFO ts=2023-01-24T11:33:22.8654724Z app=security-bootstrapper source=variables.go:377 msg="Variables override of 'StageGate.Database.ReadyPort' by environment variable: STAGEGATE_DATABASE_READYPORT=6379"
level=INFO ts=2023-01-24T11:33:22.8654921Z app=security-bootstrapper source=variables.go:377 msg="Variables override of 'StageGate.SecretStoreSetup.Tokens.ReadyPort' by environment variable: STAGEGATE_SECRETSTORESETUP_TOKENS_READYPORT=54322"
level=INFO ts=2023-01-24T11:33:22.8655083Z app=security-bootstrapper source=variables.go:377 msg="Variables override of 'StageGate.Registry.ReadyPort' by environment variable: STAGEGATE_REGISTRY_READYPORT=54324"
level=INFO ts=2023-01-24T11:33:22.8655183Z app=security-bootstrapper source=variables.go:377 msg="Variables override of 'StageGate.KongDB.Port' by environment variable: STAGEGATE_KONGDB_PORT=5432"
level=INFO ts=2023-01-24T11:33:22.8655325Z app=security-bootstrapper source=variables.go:377 msg="Variables override of 'StageGate.Database.Host' by environment variable: STAGEGATE_DATABASE_HOST=edgex-redis"
level=INFO ts=2023-01-24T11:33:22.8655426Z app=security-bootstrapper source=variables.go:377 msg="Variables override of 'StageGate.KongDB.ReadyPort' by environment variable: STAGEGATE_KONGDB_READYPORT=54325"
level=INFO ts=2023-01-24T11:33:22.8655758Z app=security-bootstrapper source=variables.go:377 msg="Variables override of 'StageGate.BootStrapper.StartPort' by environment variable: STAGEGATE_BOOTSTRAPPER_STARTPORT=54321"
level=INFO ts=2023-01-24T11:33:22.8655882Z app=security-bootstrapper source=variables.go:377 msg="Variables override of 'StageGate.Registry.Host' by environment variable: STAGEGATE_REGISTRY_HOST=edgex-core-consul"
level=INFO ts=2023-01-24T11:33:22.8656199Z app=security-bootstrapper source=variables.go:377 msg="Variables override of 'SecretStore.Port' by environment variable: SECRETSTORE_PORT=8200"
level=INFO ts=2023-01-24T11:33:22.8656319Z app=security-bootstrapper source=variables.go:377 msg="Variables override of 'StageGate.Database.Port' by environment variable: STAGEGATE_DATABASE_PORT=6379"
level=INFO ts=2023-01-24T11:33:22.8656462Z app=security-bootstrapper source=variables.go:377 msg="Variables override of 'StageGate.WaitFor.Timeout' by environment variable: STAGEGATE_WAITFOR_TIMEOUT=60s"
level=INFO ts=2023-01-24T11:33:22.8656555Z app=security-bootstrapper source=variables.go:377 msg="Variables override of 'StageGate.Registry.Port' by environment variable: STAGEGATE_REGISTRY_PORT=8500"
level=INFO ts=2023-01-24T11:33:22.8656645Z app=security-bootstrapper source=variables.go:377 msg="Variables override of 'StageGate.SecretStoreSetup.Host' by environment variable: STAGEGATE_SECRETSTORESETUP_HOST=edgex-security-secretstore-setup"
level=INFO ts=2023-01-24T11:33:22.865677Z app=security-bootstrapper source=variables.go:377 msg="Variables override of 'StageGate.BootStrapper.Host' by environment variable: STAGEGATE_BOOTSTRAPPER_HOST=edgex-security-bootstrapper"
level=INFO ts=2023-01-24T11:33:22.8656863Z app=security-bootstrapper source=variables.go:377 msg="Variables override of 'StageGate.Ready.ToRunPort' by environment variable: STAGEGATE_READY_TORUNPORT=54329"
level=INFO ts=2023-01-24T11:33:22.8656996Z app=security-bootstrapper source=variables.go:377 msg="Variables override of 'SecretStore.Host' by environment variable: SECRETSTORE_HOST=edgex-vault"
level=INFO ts=2023-01-24T11:33:22.8657778Z app=security-bootstrapper source=config.go:556 msg="Using local configuration from file (17 envVars overrides applied)"
level=INFO ts=2023-01-24T11:33:22.8658304Z app=security-bootstrapper source=command.go:119 msg="Security bootstrapper running waitFor"
level=INFO ts=2023-01-24T11:33:22.8658626Z app=security-bootstrapper source=command.go:144 msg="Waiting for: [tcp://edgex-security-bootstrapper:54329] with timeout: [1m0s]"
level=INFO ts=2023-01-24T11:33:22.8666987Z app=security-bootstrapper source=command.go:209 msg="Problem with dial: dial tcp 172.24.0.2:54329: connect: connection refused. Sleeping 1s"
level=INFO ts=2023-01-24T11:33:23.8743874Z app=security-bootstrapper source=command.go:209 msg="Problem with dial: dial tcp 172.24.0.2:54329: connect: connection refused. Sleeping 1s"
level=INFO ts=2023-01-24T11:33:24.9175374Z app=security-bootstrapper source=command.go:209 msg="Problem with dial: dial tcp 172.24.0.2:54329: connect: connection refused. Sleeping 1s"
level=INFO ts=2023-01-24T11:33:25.9187094Z app=security-bootstrapper source=command.go:209 msg="Problem with dial: dial tcp 172.24.0.2:54329: connect: connection refused. Sleeping 1s"
level=INFO ts=2023-01-24T11:33:26.9198614Z app=security-bootstrapper source=command.go:209 msg="Problem with dial: dial tcp 172.24.0.2:54329: connect: connection refused. Sleeping 1s"
level=INFO ts=2023-01-24T11:33:27.9206956Z app=security-bootstrapper source=command.go:209 msg="Problem with dial: dial tcp 172.24.0.2:54329: connect: connection refused. Sleeping 1s"
level=INFO ts=2023-01-24T11:33:28.9220274Z app=security-bootstrapper source=command.go:209 msg="Problem with dial: dial tcp 172.24.0.2:54329: connect: connection refused. Sleeping 1s"
level=INFO ts=2023-01-24T11:33:29.9254158Z app=security-bootstrapper source=command.go:209 msg="Problem with dial: dial tcp 172.24.0.2:54329: connect: connection refused. Sleeping 1s"
level=INFO ts=2023-01-24T11:33:30.9264691Z app=security-bootstrapper source=command.go:209 msg="Problem with dial: dial tcp 172.24.0.2:54329: connect: connection refused. Sleeping 1s"
level=INFO ts=2023-01-24T11:33:31.9273281Z app=security-bootstrapper source=command.go:209 msg="Problem with dial: dial tcp 172.24.0.2:54329: connect: connection refused. Sleeping 1s"
level=INFO ts=2023-01-24T11:33:32.9286276Z app=security-bootstrapper source=command.go:209 msg="Problem with dial: dial tcp 172.24.0.2:54329: connect: connection refused. Sleeping 1s"
level=INFO ts=2023-01-24T11:33:33.929608Z app=security-bootstrapper source=command.go:209 msg="Problem with dial: dial tcp 172.24.0.2:54329: connect: connection refused. Sleeping 1s"
level=INFO ts=2023-01-24T11:33:34.9309079Z app=security-bootstrapper source=command.go:209 msg="Problem with dial: dial tcp 172.24.0.2:54329: connect: connection refused. Sleeping 1s"
level=INFO ts=2023-01-24T11:33:35.9323025Z app=security-bootstrapper source=command.go:209 msg="Problem with dial: dial tcp 172.24.0.2:54329: connect: connection refused. Sleeping 1s"
level=INFO ts=2023-01-24T11:33:36.9335147Z app=security-bootstrapper source=command.go:209 msg="Problem with dial: dial tcp 172.24.0.2:54329: connect: connection refused. Sleeping 1s"
level=INFO ts=2023-01-24T11:33:37.9350443Z app=security-bootstrapper source=command.go:209 msg="Problem with dial: dial tcp 172.24.0.2:54329: connect: connection refused. Sleeping 1s"
level=INFO ts=2023-01-24T11:33:38.9361393Z app=security-bootstrapper source=command.go:209 msg="Problem with dial: dial tcp 172.24.0.2:54329: connect: connection refused. Sleeping 1s"
level=INFO ts=2023-01-24T11:33:39.9376128Z app=security-bootstrapper source=command.go:209 msg="Problem with dial: dial tcp 172.24.0.2:54329: connect: connection refused. Sleeping 1s"
level=INFO ts=2023-01-24T11:33:40.9386428Z app=security-bootstrapper source=command.go:209 msg="Problem with dial: dial tcp 172.24.0.2:54329: connect: connection refused. Sleeping 1s"
level=INFO ts=2023-01-24T11:33:41.9396406Z app=security-bootstrapper source=command.go:209 msg="Problem with dial: dial tcp 172.24.0.2:54329: connect: connection refused. Sleeping 1s"
level=INFO ts=2023-01-24T11:33:42.9414559Z app=security-bootstrapper source=command.go:209 msg="Problem with dial: dial tcp 172.24.0.2:54329: connect: connection refused. Sleeping 1s"
level=INFO ts=2023-01-24T11:33:43.9426255Z app=security-bootstrapper source=command.go:209 msg="Problem with dial: dial tcp 172.24.0.2:54329: connect: connection refused. Sleeping 1s"
level=INFO ts=2023-01-24T11:33:44.9443935Z app=security-bootstrapper source=command.go:209 msg="Problem with dial: dial tcp 172.24.0.2:54329: connect: connection refused. Sleeping 1s"
level=INFO ts=2023-01-24T11:33:45.9454926Z app=security-bootstrapper source=command.go:209 msg="Problem with dial: dial tcp 172.24.0.2:54329: connect: connection refused. Sleeping 1s"
level=INFO ts=2023-01-24T11:33:46.9466702Z app=security-bootstrapper source=command.go:209 msg="Problem with dial: dial tcp 172.24.0.2:54329: connect: connection refused. Sleeping 1s"
level=INFO ts=2023-01-24T11:33:47.9485934Z app=security-bootstrapper source=command.go:209 msg="Problem with dial: dial tcp 172.24.0.2:54329: connect: connection refused. Sleeping 1s"
level=INFO ts=2023-01-24T11:33:48.9497412Z app=security-bootstrapper source=command.go:209 msg="Problem with dial: dial tcp 172.24.0.2:54329: connect: connection refused. Sleeping 1s"
level=INFO ts=2023-01-24T11:33:49.952003Z app=security-bootstrapper source=command.go:209 msg="Problem with dial: dial tcp 172.24.0.2:54329: connect: connection refused. Sleeping 1s"
level=INFO ts=2023-01-24T11:33:50.9539926Z app=security-bootstrapper source=command.go:209 msg="Problem with dial: dial tcp 172.24.0.2:54329: connect: connection refused. Sleeping 1s"
level=INFO ts=2023-01-24T11:33:51.9549977Z app=security-bootstrapper source=command.go:209 msg="Problem with dial: dial tcp 172.24.0.2:54329: connect: connection refused. Sleeping 1s"
level=INFO ts=2023-01-24T11:33:52.9563143Z app=security-bootstrapper source=command.go:209 msg="Problem with dial: dial tcp 172.24.0.2:54329: connect: connection refused. Sleeping 1s"
level=INFO ts=2023-01-24T11:33:53.95728Z app=security-bootstrapper source=command.go:209 msg="Problem with dial: dial tcp 172.24.0.2:54329: connect: connection refused. Sleeping 1s"
level=INFO ts=2023-01-24T11:33:54.9596338Z app=security-bootstrapper source=command.go:209 msg="Problem with dial: dial tcp 172.24.0.2:54329: connect: connection refused. Sleeping 1s"
level=INFO ts=2023-01-24T11:33:55.9608624Z app=security-bootstrapper source=command.go:209 msg="Problem with dial: dial tcp 172.24.0.2:54329: connect: connection refused. Sleeping 1s"
level=INFO ts=2023-01-24T11:33:56.9619031Z app=security-bootstrapper source=command.go:209 msg="Problem with dial: dial tcp 172.24.0.2:54329: connect: connection refused. Sleeping 1s"
level=INFO ts=2023-01-24T11:33:57.9630382Z app=security-bootstrapper source=command.go:209 msg="Problem with dial: dial tcp 172.24.0.2:54329: connect: connection refused. Sleeping 1s"
level=INFO ts=2023-01-24T11:33:58.96423Z app=security-bootstrapper source=command.go:209 msg="Problem with dial: dial tcp 172.24.0.2:54329: connect: connection refused. Sleeping 1s"
level=INFO ts=2023-01-24T11:33:59.9650862Z app=security-bootstrapper source=command.go:209 msg="Problem with dial: dial tcp 172.24.0.2:54329: connect: connection refused. Sleeping 1s"
level=INFO ts=2023-01-24T11:34:00.9660354Z app=security-bootstrapper source=command.go:209 msg="Problem with dial: dial tcp 172.24.0.2:54329: connect: connection refused. Sleeping 1s"
level=INFO ts=2023-01-24T11:34:01.9683322Z app=security-bootstrapper source=command.go:209 msg="Problem with dial: dial tcp 172.24.0.2:54329: connect: connection refused. Sleeping 1s"
level=INFO ts=2023-01-24T11:34:02.9695731Z app=security-bootstrapper source=command.go:209 msg="Problem with dial: dial tcp 172.24.0.2:54329: connect: connection refused. Sleeping 1s"
level=INFO ts=2023-01-24T11:34:03.9716488Z app=security-bootstrapper source=command.go:209 msg="Problem with dial: dial tcp 172.24.0.2:54329: connect: connection refused. Sleeping 1s"
level=INFO ts=2023-01-24T11:34:04.9738815Z app=security-bootstrapper source=command.go:209 msg="Problem with dial: dial tcp 172.24.0.2:54329: connect: connection refused. Sleeping 1s"
level=INFO ts=2023-01-24T11:34:05.9750837Z app=security-bootstrapper source=command.go:209 msg="Problem with dial: dial tcp 172.24.0.2:54329: connect: connection refused. Sleeping 1s"
level=INFO ts=2023-01-24T11:34:06.976199Z app=security-bootstrapper source=command.go:209 msg="Problem with dial: dial tcp 172.24.0.2:54329: connect: connection refused. Sleeping 1s"
level=INFO ts=2023-01-24T11:34:07.9777724Z app=security-bootstrapper source=command.go:209 msg="Problem with dial: dial tcp 172.24.0.2:54329: connect: connection refused. Sleeping 1s"
level=INFO ts=2023-01-24T11:34:08.9791586Z app=security-bootstrapper source=command.go:209 msg="Problem with dial: dial tcp 172.24.0.2:54329: connect: connection refused. Sleeping 1s"
level=INFO ts=2023-01-24T11:34:09.980513Z app=security-bootstrapper source=command.go:209 msg="Problem with dial: dial tcp 172.24.0.2:54329: connect: connection refused. Sleeping 1s"
level=INFO ts=2023-01-24T11:34:10.9818146Z app=security-bootstrapper source=command.go:209 msg="Problem with dial: dial tcp 172.24.0.2:54329: connect: connection refused. Sleeping 1s"
level=INFO ts=2023-01-24T11:34:11.9827167Z app=security-bootstrapper source=command.go:209 msg="Problem with dial: dial tcp 172.24.0.2:54329: connect: connection refused. Sleeping 1s"
level=INFO ts=2023-01-24T11:34:12.9841914Z app=security-bootstrapper source=command.go:209 msg="Problem with dial: dial tcp 172.24.0.2:54329: connect: connection refused. Sleeping 1s"
level=INFO ts=2023-01-24T11:34:13.985874Z app=security-bootstrapper source=command.go:209 msg="Problem with dial: dial tcp 172.24.0.2:54329: connect: connection refused. Sleeping 1s"
level=INFO ts=2023-01-24T11:34:14.9875083Z app=security-bootstrapper source=command.go:209 msg="Problem with dial: dial tcp 172.24.0.2:54329: connect: connection refused. Sleeping 1s"
level=INFO ts=2023-01-24T11:34:15.9885323Z app=security-bootstrapper source=command.go:209 msg="Problem with dial: dial tcp 172.24.0.2:54329: connect: connection refused. Sleeping 1s"
level=INFO ts=2023-01-24T11:34:16.9896585Z app=security-bootstrapper source=command.go:209 msg="Problem with dial: dial tcp 172.24.0.2:54329: connect: connection refused. Sleeping 1s"
level=INFO ts=2023-01-24T11:34:17.990664Z app=security-bootstrapper source=command.go:209 msg="Problem with dial: dial tcp 172.24.0.2:54329: connect: connection refused. Sleeping 1s"
level=INFO ts=2023-01-24T11:34:18.9923766Z app=security-bootstrapper source=command.go:209 msg="Problem with dial: dial tcp 172.24.0.2:54329: connect: connection refused. Sleeping 1s"
level=INFO ts=2023-01-24T11:34:19.993335Z app=security-bootstrapper source=command.go:209 msg="Problem with dial: dial tcp 172.24.0.2:54329: connect: connection refused. Sleeping 1s"
level=INFO ts=2023-01-24T11:34:20.9944126Z app=security-bootstrapper source=command.go:209 msg="Problem with dial: dial tcp 172.24.0.2:54329: connect: connection refused. Sleeping 1s"
level=INFO ts=2023-01-24T11:34:21.9957242Z app=security-bootstrapper source=command.go:209 msg="Problem with dial: dial tcp 172.24.0.2:54329: connect: connection refused. Sleeping 1s"
level=ERROR ts=2023-01-24T11:34:22.8659773Z app=security-bootstrapper source=init.go:90 msg="Timeout after 1m0s waiting on dependencies to become available: [tcp://edgex-security-bootstrapper:54329]"