test

Sun OpenSSO Enterprise 8.0 Administration Guide

Appendix A Changing the Host Name of an OpenSSO Instance

After opensso.war is deployed in a web container, the installed OpenSSO instance is uniquely identified by a URL defined with a protocol (http/https), a host name, a port and a deployment URI; for example, http://ipg-test2.sun.com:8080/opensso. This URL is defined in the OpenSSO bootstrap file as well as in various places in the service configuration data store. When the web container on which OpenSSO is deployed is restarted, OpenSSO uses the bootstrap URL to locate its system properties in the service configuration data store and start itself. Additionally, almost all federation and web services endpoints contain this URL. Thus, to change the host name on which the instance of OpenSSO has been installed, use the following procedure.

Note –

For this procedure, assume the current OpenSSO URL is http://current.example.com:58080/opensso, and the new OpenSSO URL will be http://new.example1.com:8080/opensso1.

  1. Login to the OpenSSO console as administrator; by default, amadmin.

  2. Click the Access Control tab.

  3. Click / Top Level Realm.

  4. Add the new host name as a value for the Realm/DNS Aliases attribute.

    For example, new.example1.com.

  5. Export the service configuration data to a file named export.xml.

    See Chapter 15, Backing Up and Restoring Configuration Data for information.

  6. Copy export.xml to new.xml.

  7. Open new.xml and make the following changes.

    1. Search for 

      <SubConfiguration name=
"http://current.example.com:58080/opensso" id="server">

      and:

      • Change

        <Value>com.iplanet.am.services.deploymentDescriptor=/opensso</Value>

        to

        <Value>com.iplanet.am.services.deploymentDescriptor=/opensso1<Value>

      • Change

        <Value>com.iplanet.am.server.port=58080</Value>

        to

        <Value>com.iplanet.am.server.port=8080</Value>

      • Change

        <Value>com.iplanet.am.server.host=current.example.com</Value>

        to

        <Value>com.iplanet.am.server.host=new.example1.com</Value>

    2. Search for

      <Service name= "iPlanetAMAuthConfiguration" version="1.0">
<Schema i18nFileName="amAuthConfig" 
i18nKey="iplanet-am-auth-config-service-description" 
propertiesViewBeanURL="opensso/auth/ACServiceInstanceList">

      and change opensso to opensso1.

    3. Search for

      <SubSchema inheritance= "multiple" 
maintainPriority="no" name="NamedConfiguration" 
supportsApplicableOrganization="no" validate="yes">
<AttributeSchema cosQualifier="default" i18nKey="a101" 
isSearchable="no" name="iplanet-am-auth-configuration" 
propertiesViewBeanURL="opensso/auth/ACModuleList">

      and change opensso to opensso1.

    4. Search for

      <AttributeSchema cosQualifier= "default" 
i18nKey="a133" isSearchable="no" 
name="iplanet-am-auth-login-success-url" syntax="string" 
type="list"><DefaultValues><Value>/opensso/console</Value>

      and change opensso to opensso1.

    5. Search for

      <AttributeValuePair>
<Attribute name= "sunOrganizationAliases"/>
<Value>opensso</Value>

      and change opensso to opensso1.

    6. Search for

      <AttributeSchema cosQualifier= "default" 
i18nKey="a103" isSearchable="no" 
name="iplanet-am-platform-cookie-domains" syntax="string" 
type="list"><DefaultValues><Value>.example.com</Value>

      and change the cookie domain from.example.com to .example1.com.

    7. Substitute the following strings:

      • http://new.example1.com:8080/opensso1 for http://current.example.com:58080/opensso

      • new.example1.com:8080 for current.example.com:58080

  8. Save new.xml.

  9. Backup the OpenSSO configuration data.

    This backup can be used to restore a previous configuration. If the OpenSSO configuration data store is the default embedded OpenDS, backup the contents of OpenSSO-ConfigDir. OpenSSO-ConfigDir represents the name of the directory specified as the configuration directory during initial configuration of OpenSSO. By default, an opensso directory would be created in the home directory of the user configuring the instance. Thus, if root is configuring the instance, OpenSSO-ConfigDir is /opensso. If any other directory server is used, work with the administrator to back up the OpenSSO configuration data before proceeding.

  10. Import new.xml back into OpenSSO.

    See Chapter 15, Backing Up and Restoring Configuration Data for information.

  11. Stop the web container.

  12. Replace http%3A%2F%2Fcurrent.example.com%3A58080%2Fopensso with http%3A%2F%2Fnew.example1.com%3A8080%2Fopensso1 in the OpenSSO-ConfigDir/bootstrap file.

    During OpenSSO deployment, a setup servlet creates a file named bootstrap in the OpenSSO configuration directory. This file contains the information that points to a location from which OpenSSO can retrieve configuration data to bootstrap itself.

  13. Change the deploy context on the OpenSSO web container to opensso1.

    Check the your web container's documentation for instructions.

  14. Move OpenSSO-ConfigDir/opensso to OpenSSO-ConfigDir/opensso1.

    Be sure to backup this directory first.

  15. Change to the user-home/.openssocfg directory.

    A file named with the prefix AMConfig is in this directory; for example, AMConfig_usr_local_tomcat_webapps_opensso or AMConfig_opt_jboss-4.2.2.GA_server_fam2_._deploy_opensso.war_. user-home is the home directory of the user who configured the instance of OpenSSO.

  16. Change opensso in the AMConfig* file to opensso1.

  17. Start the web container.

  18. Log in to OpenSSO as the administrator using the new URL (and host name); by default, amadmin.

  19. Click the Access Control tab.

  20. Click / Top Level Realm.

  21. Remove current.example.com, the old host name, from the Realm/DNS Aliases attribute.

This second procedure documents how to restore the previous host name. It is based on the examples and information used in the previous procedure.

  1. Edit OpenSSO-ConfigDir/bootstrap by changing the new encoded URL back to the old encoded URL.

  2. Import export.xml back into OpenSSO.

  3. Change the deploy context on the OpenSSO web container back to opensso.

  4. Move OpenSSO-ConfigDir/opensso1 to OpenSSO-ConfigDir/opensso.

  5. Change opensso1 in the AMConfig* file (located in the user-home/.openssocfg directory) back to opensso.

  6. Restart the web container.