Skip to content

Commit

Permalink
Documentation on how get full IP list #72
Browse files Browse the repository at this point in the history
Co-authored-by: Dominika Vagnerova <[email protected]>
  • Loading branch information
rigazilla and domiborges authored Oct 10, 2023
1 parent ebc4f9c commit 682a515
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 0 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ After you configure and deploy {brandname} clusters you can establish remote con
include::{topics}/proc_connecting_console.adoc[leveloffset=+1]
include::{topics}/proc_connecting_cli.adoc[leveloffset=+1]
include::{topics}/proc_connecting_clients_internal.adoc[leveloffset=+1]
include::{topics}/proc_obtaining_IP_address.adoc[leveloffset=+2]
include::{topics}/proc_connecting_clients_external.adoc[leveloffset=+1]
include::{topics}/proc_connecting_rest.adoc[leveloffset=+1]

Expand Down
24 changes: 24 additions & 0 deletions documentation/asciidoc/topics/proc_obtaining_IP_address.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
[id='obtaining_IP_addresses_{context}']
= Obtaining IP addresses for all {brandname} pods

[role="_abstract"]
You can retrieve a list of all IP addresses for running {brandname} pods.

[IMPORTANT]
====
link:{helm_docs}#connecting-clients-internal_connecting-clusters[Connecting Hot Rod clients running on {k8s}] is the recommended approach as it ensures the initial connection to one of the available pods.
====

.Procedure
Obtain all the IP addresses for a running {brandname} pods in the following ways:

* Using the {k8s} API:
** Access `${APISERVER}/api/v1/namespaces/<chart-namespace>/endpoints/<helm-release-name>` to retrieve the `endpoints` {k8s} resource associated with the `<helm-release-name>` service.

* Using the {k8s} DNS service:
** Query the DNS service for the name `<helm-release-name>-ping` to obtain IPs for all the nodes in a cluster.

[role="_additional-resources"]
.Additional resources
* link:https://kubernetes.io/docs/tasks/run-application/access-api-from-pod/[Accessing the Kubernetes API from a Pod]
* link:https://kubernetes.io/docs/concepts/services-networking/dns-pod-service/[DNS for Services and Pods]

0 comments on commit 682a515

Please sign in to comment.