diff --git a/docs/_static/img/linking/linking-example-sonarrsabnzbd.png b/docs/_static/img/linking/linking-example-sonarrsabnzbd.png new file mode 100644 index 00000000000..688025efddb Binary files /dev/null and b/docs/_static/img/linking/linking-example-sonarrsabnzbd.png differ diff --git a/docs/manual/linking.md b/docs/manual/linking.md index 1625857ceff..cbf03c97a2d 100644 --- a/docs/manual/linking.md +++ b/docs/manual/linking.md @@ -1,22 +1,33 @@ # Linking Apps Together -We often need to connect individual apps together, for example: Ombi and Plex. This means we first need to know how to reach those Apps. +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 different than in other systems, as you can't point directly to other Containers using their IP-Address. +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. -Instead we need to use their internal(!) domain name. Please be ware: 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` +- `$APPNAME.ix-$APPNAME.svc.cluster.local` -However, 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: +Kubernetes can usually identify the app when omitting `svc.cluster.local` as well: +- `$APPNAME.ix-$APPNAME` -`$SVCNAME.ix-$APPNAME.svc.cluster.local` +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: -*For example:* +- `$SVCNAME.ix-$APPNAME.svc.cluster.local` or +- `$SVCNAME.ix-$APPNAME` -To reach an app named "plex", we use the following internal domain name: +##### Example -`plex.ix-plex.svc.cluster.local` +To reach an app named "sabnzbd" within Sonarr, we can use the following internal domain name: + +- `sabnzbd.ix-sabnzbd` + + + +##### Additional Documentation + +For more help troubleshooting DNS resolution in Kubernetes, review the official documentation: https://kubernetes.io/docs/concepts/services-networking/dns-pod-service/ \ No newline at end of file