Files
truecharts/docs/manual/linking.md
ksimm1 0d919bc8f8 docs update - linking apps domain names (#440)
Added detail to docs on shortened domain name resolution, added screenshot example and link to official K8s
2021-05-06 19:35:35 +02:00

33 lines
1.6 KiB
Markdown

# Linking Apps Together
We often need to connect individual apps together, for example: Sonarr and SABnzbd. This means we first need to know how to reach those Apps.
##### Linking Apps Internally
The backend for TrueNAS SCALE Apps is Kubernetes. Linking apps together in Kubernetes is done slightly differently than in other systems, as you can't point directly to other containers using their IP address.
Instead we need to use their internal(!) domain name. Please beware: this name is only available between Apps and can not be reached from the host/node or your own PC.
The format for internal domain name for the main service is as follows, please replace `$APPNAME` with the name you gave your App when installing.
- `$APPNAME.ix-$APPNAME.svc.cluster.local`
Kubernetes can usually identify the app when omitting `svc.cluster.local` as well:
- `$APPNAME.ix-$APPNAME`
If you need to reach a different service (which is not often the case!), you need a slightly different format, where `$SVCNAME` is the name of the service you want to reach:
- `$SVCNAME.ix-$APPNAME.svc.cluster.local` or
- `$SVCNAME.ix-$APPNAME`
##### Example
To reach an app named "sabnzbd" within Sonarr, we can use the following internal domain name:
- `sabnzbd.ix-sabnzbd`
<a href="https://truecharts.org/_static/img/linking/linking-example-sonarrsabnzbd.png"><img src="https://truecharts.org/_static/img/linking/linking-example-sonarrsabnzbd.png" width="100%"/></a>
##### Additional Documentation
For more help troubleshooting DNS resolution in Kubernetes, review the official documentation: https://kubernetes.io/docs/concepts/services-networking/dns-pod-service/