ALERT: Some images may not load properly within the Knowledge Base Article. If you see a broken image, please right-click and select 'Open image in a new tab'. We apologize for this inconvenience.

How to Change the Gateway HostName , Portal Domain and Tenant Name ?

book

Article ID: 208677

calendar_today

Updated On:

Products

CA API Gateway

Issue/Introduction

Recently we setup new 10.x environment with the hostname of apidev.mydomain.com . Customer want to update hostname as well as domain name like apiservices.labcorp.com

to achieve this what are all the configuration changes required ?

And we are looking detail to update/change apiportal  tenant name too. 

Environment

Release : 10.0

Component : API GATEWAY, API DEV PORTAL 4.x , 5.0

Resolution

If you have the environment already set  with the original name "apidev.mydomain.com" the advise will be to re-configure

the gateway and Portal again to have the new hostnames and domain name in Place. 

1. on Gw , you need to re-run the Network configuration again to modify the hostname ,domain name, Cluster hostname.

2. on Portal, you will need to change the hostname (Portal Server Hostname) and re-run the config.sh again to set the portal domain, enroll notification email domain. 

3. ensure all service names Names refers to new Domain in the /etc/hosts 

example :

 myPortalserverName.apiservices.labcorp.com
 tenant-NewTenantNameHere.t5.apiservices.labcorp.com
 apim-ssg.t5.apiservices.labcorp.com
 apim.t5.apiservices.labcorp.com
 analytics.t5.apiservices.labcorp.com
 broker.t5.apiservices.labcorp.com
 sso.t5.apiservices.labcorp.com
 sync.t5.apiservices.labcorp.com
 enroll.t5.apiservices.labcorp.com

Notes : 

- myPortalserverName.apiservices.labcorp.com                   (belongs to your Portal server)
-  tenant-NewTenantNameHere.t5.apiservices.labcorp.com (belongs to the tenant name you provided when running config.sh)

- All other names are hardcoded on Portal deployment, you cannot modify those names (apim,analytics,broker, sso, sync, enroll).

4. Then , when run ./portal.sh to start the services and keys with the new domain name.

After that, will need to create a new tenant with the new domain name.

5. Portal Tenant Name cannot be modified, you need to create a new tenant.

Notes :
- With new tenant creation will require to migrate all tenant data from original to new.
- The better approach would be to create a new tenant and then use PAPI to migrate out the artifacts and then re-import them.
- Alternatively you could put a proxy to re-write the URLS that need to hidden.