Versions Compared

Old Version 9

changes.mady.by.user Former user

Saved on

compared with

New Version 10

changes.mady.by.user Former user

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Warning
titleWIP

This document is work in progress!

This document guides on how to configure the ports in wso2 IoT Server. To make the steps clear, a sample port offset scenario is covered. Follow the steps given below:There are situations when the default port needs to be changed using a port offset  (e.g., when configuring WSO2 IoT Server with WSO2 Identity Server). When the port offset is set, WSO2 IoT Server starts on a different port, and it changes the default TCP port by increasing the value of the port. Therefore, for WOS2 IoT Server to function properly the port in the TCP connection URL that corresponds to the various WSO2 IoT Server related configuration files need to be updated.

Info
titleWhat is port offset

The port offset feature allows you to run multiple WSO2 products, multiple instances of a WSO2 product, or multiple WSO2 product clusters on the same server or virtual machine (VM). The port offset defines the number by which all ports defined in the runtime, such as the HTTP/S ports, need to be offset. For example, if the HTTP port is defined as 9763 and the port Offset is 1, the effective HTTP port changes to 9764. Therefore, for each additional WSO2 product, instance, or cluster you add to a server, set the port offset to a unique value (the default is 0).

Note

WSO2 IoT Server compromises of the IoT core, analytics and broker profiles. By default, the three profiles have the following offsets:

ProfileOffsetDefault port
Core09443/9763
Analytics29445/9765
Broker39446/9766

When port offsetting you need to make Make sure that the port offset of each profile differs from each other. No two profiles can have the same offset. Else, you will run into errors.


Follow the instructions below to enable port offset in WSO2 IoT Server :


  1. Configure the carbon.xmlfiles xml files of the three profile to port offset.

    Core

    Open the <IOTS_HOME>/conf/carbon.xml file and port offset the IoT Server's core profile by configuring the <Offset> attribute.

    Note

    Make sure that the offset value is not to have the same offset values as the broker or analytics profile.

    Example:

    Code Block
    <Offset>4</Offset>

    Now the port of the core profile is 9447/9767.

    Analytics

    Open the <IOTS_HOME>/wso2/analytics/conf/carbon.xml file and port offset the IoT Server's core profile by configuring the <Offset> attribute.

    Note

    Make sure that the offset value is not to have the same offset values as the broker or analytics profile.

    Code Block
    <Offset>5</Offset>

    Now the port of the core profile is 9448/9768.

    Broker

    Open the <IOTS_HOME>/wso2/broker/conf/carbon.xml file and port offset the IoT Server's core profile by configuring the <Offset> attribute.

    Note

    Make sure that the offset value is not to have the same offset values as the broker or analytics profile.

    Code Block
    <Offset>6</Offset>

    Now the port of the core profile is 9449/9769.

  2. Open the <IOTS_HOME>/bin/ iot -server.sh or iot-server.bat file configures the following portsproperties:

    Analytics ports

    By default the analytics profileisoffset profile is offset by 2. In step 1, you offset the analytics profile by 3 more again. Therefore, all the ports relevant to the analytics need profile needs to be offset by 3 more.

    Example:

    Code Block
    -Diot.analytics.https.port="9448" \
    Broker ports

    By default, the broker profile is offset by 3. In step 1, you offset the broker profile by 3 more. Therefore, all the ports relevant to the broker need profile needs to be offset by 3.

    Example:

    Code Block
    -Dmqtt.broker.port="1889" \
    IoT core ports

    By default the core profile is not offset by 0. In step 1, you offset the broker profile by 4. Therefore, all the ports relevant to the core profile needs to be offset by 4.
    Example:

    Code Block
    -Diot.manager.https.port="9447" \
-Diot.core.https.port="9447" \
-Diot.keymanager.https.port="9447" \
-Diot.gateway.https.port="8247" \
-Diot.gateway.http.port="8284" \
-Diot.gateway.carbon.https.port="9447" \
-Diot.gateway.carbon.http.port="9767" \
-Diot.apimpublisher.https.port="9447" \
-Diot.apimstore.https.port="9447" \

  3. Open the <IOTS_HOME>/wso2/analytics/bin/wso2 server.sh  or wso2server.bat file configures the following portsproperties:

    Broker ports

    By default, the broker profile is offset by 3. In step 1, you offset the broker profile by 3 more. Therefore, all the ports relevant to the broker need profile needs to be offset by 3.

    Example:

    Code Block
    -Dmqtt.broker.port="1889" \
    IoT core ports

    By default the core profile is not offset by 0. In step 1, you offset the core profile by 4. Therefore, all the ports relevant to the core profile needs to be offset by 4.
    Example:

    Code Block
    -Diot.keymanager.https.port="9447" \
-Diot.gateway.https.port="8247" \

  4. Configure following properties in the <IOTS_HOME>/conf/identity/ sso-idp-config.xml file.

    IoT core

    By default the core profile is not offset by 0. In step 1, you offset the core profile by 4. Therefore, all the ports relevant to core needs to be offset by 4.
    Example:

    Code Block
    <AssertionConsumerServiceURL>https://localhost:9447/devicemgt/uuf/sso/acs</AssertionConsumerServiceURL>
<DefaultAssertionConsumerServiceURL>https://localhost:9447/devicemgt/uuf/sso/acs</DefaultAssertionConsumerServiceURL>
<Audience>https://localhost:9447/oauth2/token</Audience>
<Recipient>https://localhost:9447/oauth2/token</Recipient>
<AssertionConsumerServiceURL>https://localhost:9447/store/acs</AssertionConsumerServiceURL>
<DefaultAssertionConsumerServiceURL>https://localhost:9447/store/acs</DefaultAssertionConsumerServiceURL>
<AssertionConsumerServiceURL>https://localhost:9447/social/acs</AssertionConsumerServiceURL>
<DefaultAssertionConsumerServiceURL>https://localhost:9447/social/acs</DefaultAssertionConsumerServiceURL>
<AssertionConsumerServiceURL>https://localhost:9447/publisher/acs</AssertionConsumerServiceURL>
<DefaultAssertionConsumerServiceURL>https://localhost:9447/publisher/acs</DefaultAssertionConsumerServiceURL>
<AssertionConsumerServiceURL>https://localhost:9447/api-store/jagg/jaggery_acs.jag</AssertionConsumerServiceURL>
<DefaultAssertionConsumerServiceURL>https://localhost:9447/api-store/jagg/jaggery_acs.jag</DefaultAssertionConsumerServiceURL>
<AssertionConsumerServiceURL>https://localhost:9447/portal/acs</AssertionConsumerServiceURL>
<DefaultAssertionConsumerServiceURL>https://localhost:9447/portal/acs</DefaultAssertionConsumerServiceURL>
<Audience>https://localhost:9447/oauth2/token</Audience>
<Recipient>https://localhost:9447/oauth2/token</Recipient>
<Audience>https://localhost:9447/oauth2/token</Audience>
<Recipient>https://localhost:9447/oauth2/token</Recipient>
    Analytics

    By default the analytics profile is offset by 2. In step 1, you offset the analytics profile by 3 more again. Therefore, all the ports relevant to the analytics need profile needs to be offset by 3 more.

    Example:

    Code Block
    <AssertionConsumerServiceURL>https://localhost:9448/portal/acs</AssertionConsumerServiceURL>
<DefaultAssertionConsumerServiceURL>https://localhost:9448/portal/acs</DefaultAssertionConsumerServiceURL>

  5. Open the <IOTS_HOME>/repository/deployment/server/jaggeryapps/devicemgt/app/conf/app-conf.json file and configure the following properties related to the IoT Server's core profile:
    Example:
    By default, the core profile is offset by 0. In step 1, you offset the core profile by 4. Therefore, all the ports relevant to core needs to be offset by 4.

    Code Block
    "portalURL": "https://${server.ip}:9447",

  6. Open the <IOTS_HOME>/repository/deployment/server/jaggeryapps/api-store/site/conf/site.json  file and configure the following properties and configure the following properties related to the IoT Server's core profile:
    Example:
    By default, the core profile is offset by 0. In step 1, you offset the core profile by 4. Therefore, all the ports relevant to core needs to be offset by 4. 

    Code Block
    "identityProviderURL" : "https://localhost:9447/samlsso",
"identityProviderURI" : "http://localhost:8084/openid-connect-server-webapp/",
"authorizationEndpointURI" : "http://localhost:8084/openid-connect-server-webapp/authorize",
"tokenEndpointURI" : "http://localhost:8084/openid-connect-server-webapp/token",
"userInfoURI" : "http://localhost:8084/openid-connect-server-webapp/userinfo",
"jwksURI" : "http://localhost:8084/openid-connect-server-webapp/jwk",

  7. Open the <IOTS_HOME>/conf/etc/webapp-publisher-config.xml file, and set true as the value for <EnabledUpdateApi>.

    Code Block
    <!-- If it is true, the APIs of this instance will be updated when the webapps are redeployed -->
<EnabledUpdateApi>true</EnabledUpdateApi>
    Info

    If you have not started WSO2 IoT Server previously, you don't need this configuration. When the server starts for the first time it will update the APIs and web apps with the new ports.

    Note

    Make sure to configure this property back to  false  if you need to restart the server again after the configuring the ports. 

    By enabling the update API property, the APIs and the respective web apps get updated when the server restarts. This takes some time. Therefore, if you need to restart the server many times after this configuration or when in a production environment, you need to revert back to the default setting.

Congratulations! You have successfully port offset WSO2 IoT Server's core, analytics and broker profiles. You can now start the three profiles and manage your devices.