stphnsmpsn/truecharts
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs update - linking apps domain names (#440)

Browse Source 
Added detail to docs on shortened domain name resolution, added screenshot example and link to official K8s
This commit is contained in:
ksimm1
2021-05-06 10:35:35 -07:00
committed by GitHub
parent 51703d2ecf
commit 0d919bc8f8
2 changed files with 20 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

BIN
docs/_static/img/linking/linking-example-sonarrsabnzbd.png vendored Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 71 KiB

29
docs/manual/linking.md
View File

@@ -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`
<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/