7.6 Product Version Management

7.6.1 Creating a New Product Version #

1.Login to Ahasa.

2. On the Left Pane, expand Private Catalog and click Product Management.

3. Search and identify the required product. Then click Add Version to add a new version to the product (Grid View).

A product should have at least one version on the “Active“ state for it to be used on the Canvas.

Or

4. Click ⁝ Option and select Add Version to add a new version to the product (Card View).

5. Enter the Product Version Number and click Next. Click Save & Exit if you want to save as a draft and exit the wizard.

IMPORTANT NOTE: The version number must be a numeric value and can include decimals. If a version already exists, the new version cannot precede the highest existing version (i.e: you cannot create 1.1 after creating version 1.2).

6. Enter the following information.

• Container Name – The name of the container. The container name is the name of the container which will be used for the deployment of the product version. The container Name is identified through the YAML file.

    Must contain only lowercase alphanumeric characters or '-'.
    Must start and end with an alphanumeric character.
    Leading spaces are not allowed.

    The maximum Char Limit is 63.

• Container Path – Docker file build location will be added here.

    Cannot start with a space.
    Must be a URL.

    The maximum Char Limit is 255.

• Container Ports (Optional) – According to the Container Name, enter the required container ports. The container ports are the ports of the container which will be used for the deployment of the product version.

    Only numbers are allowed.

    The minimum Char Limit is 1 and the maximum Char Limit is 255.

7. Click Next. Click Save & Exit if you want to save as a draft and exit the wizard.

8. Click Next to go to the next step. Click Save & Exit if you want to save as a draft and exit the wizard.

• Container Registry (Optional) – Enter and select the credentials for the Container Registry. This Registry can be used as a service for storing private container images.

• App Name – Select the App Name. This will show the apps which are available in the product.

    Must contain only lowercase alphanumeric characters or '-'.
    Must start and end with an alphanumeric character.
    Leading spaces are not allowed.

    The maximum Char Limit is 63.

• Type – Enter and select the Deployment Type. This can be a deployment or statefulset.

• Deployment/StatefulSet Name – This field will be displayed once the Type is selected. Enter the Deployment/StatefulSet Name. Deployment Name is used to manage application deployments. StatefulSet Name is used to manage stateful applications.

• If you want to enable a host network, then enable Host Network Enabled.

• Termination Grace Period (Optional) – Enter the Termination Grace Period. This is the grace period to keep a particular service after which the service will expire.

    Only numbers are allowed.

    The minimum Char Limit is 1 and the maximum Char Limit is 9007199254740991.

• Node Name (Optional) – Enter the Node Name. This is the node on which the product version will run. Multiple nodes can be available in a cluster.

    Must contain only lowercase alphanumeric characters or ‘-‘.
    Must start and end with an alphanumeric character.
    Leading spaces are not allowed.

    The maximum Char Limit is 63.

• Number of Replicas (Optional) – Enter the number of services that should handle the traffic or load. The replicas will be created based on the number provided.

    Only numbers are allowed.

    Kubernetes recommends a maximum number of 110 pods per node.

• Image-Pull-Secrets (Optional) – Enter the Image Pull Requests. This is used to pull docker images from the container registry. The maximum Char Limit can be defined.

• Arguments (Optional) – Enter the parameters relevant to the version. The maximum Char Limit can be defined.

• Click the Add button to add Image Pull Secrets or Arguments.

9. If the Environment Variable does not have a Reference to another product, unselect the Product checkbox and enter the following information.

These product references are added to create pre-integration between two products so that they can be used when designing solutions on the Canvas screen.

• Key (Optional) – Enter the Key of the Environment Variable. This is required to deploy the product version.

    Must be a valid environment variable name.
    Must only contain alphanumeric characters, '_', '-', or '.'.
    Must not start with a digit.
    Must not start or end with spaces.

• Value (Optional) – Enter the values of the Environment Variable added in the Keys. The maximum Char Limit can be defined.

• Enable Read Only if you want to make the variable read-only. If it’s marked as enabled, the variable cannot be modified when performing integrations on the product canvas.

• Click the Add button to add the attribute. More than one Environment Variable can be added.

10. If the Environment Variable contains a Reference to another product, select the Product checkbox and enter the following information.

These product references are added to create the pre-integration between two products so that they can be used when designing solutions on the Canvas screen.

• Key – Enter the Key of the Environment Variable.

• Reference Product – Select the reference product from the drop-down list.

• Reference Product Version – Select the version of the reference product from the list.

• Type – There can be two types. Select the type of the variable whether it is an Environment Variable or an Endpoint.

• If the Type is Environment Variable, then select the Product Environment Variable.

• If the Type is Endpoint, then enter the Endpoint Name and select the Parameters from the list.

• Enable Mandatory if you want to make the reference product a mandatory requirement on the Canvas when designing solutions.
  • Enabling this Mandatory field will mean that when this product is used on the Canvas, The product marked as referenced will be automatically included to the canvas along with it and the user shall not be able to remove it unless the main product is also removed.

• Click the Add button to add the attribute. More than one Environment Variable can be added.

11. Once all Environment Variables are added click Next.

12. Select the Liveness Probe and Readiness Probe if available. These fields are optional and can be skipped if not required.

Many applications running for long periods of time eventually transition to broken states, and cannot recover except by being restarted. Kubernetes provides liveness probes to detect and remedy such situations.

13. If the Liveness Probe/Readiness Probe is selected as Command, fill the following information.

• Command – Enter the command which is required. Click Add Command to add it.

• Initial Delay – Number of seconds after the container has started before liveness or readiness probes are initiated. Defaults to 0 seconds. The minimum value is 0.

• Period – How often (in seconds) to perform the probe. Default to 10 seconds. The minimum value is 1.

• Timeout – Number of seconds after which the probe times out. Defaults to 1 second. The minimum value is 1.

• Success Threshold – Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup Probes. The minimum value is 1.

• Failure Threshold – When a probe fails, Kubernetes will try failure threshold times before giving up. Giving up in case of a liveness probe means restarting the container. In case of readiness probe, the Pod will be marked Unready. Defaults to 3. The minimum value is 1.

14. If the Liveness Probe/Readiness Probe is selected as HTTP Get, fill the following information.

• Path – Path to access on the HTTP server. Defaults to /.

• Port – Name or number of the port to access on the container. The number must be in the range of 1 to 65535.

• Header – Custom headers to set in the request. HTTP allows repeated headers.

• Initial Delay – Number of seconds after the container has started before liveness or readiness probes are initiated. Defaults to 0 seconds. The minimum value is 0.

• Period – How often (in seconds) to perform the probe. Default to 10 seconds. The minimum value is 1.

• Timeout – Number of seconds after which the probe times out. Defaults to 1 second. The minimum value is 1.

• Success Threshold – Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup Probes. The minimum value is 1.

• Failure Threshold – When a probe fails, Kubernetes will try failure threshold times before giving up. Giving up in case of a liveness probe means restarting the container. In case of readiness probe, the Pod will be marked Unready. Defaults to 3. The minimum value is 1.

15. If the Liveness Probe/Readiness Probe is selected as TCP, fill the following information.

• Port – Name or number of the port to access on the container. The number must be in the range of 1 to 65535.

• Initial Delay – Number of seconds after the container has started before liveness or readiness probes are initiated. Defaults to 0 seconds. The minimum value is 0.

• Period – How often (in seconds) to perform the probe. Default to 10 seconds. The minimum value is 1.

• Timeout – Number of seconds after which the probe times out. Defaults to 1 second. The minimum value is 1.

• Success Threshold – Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup Probes. The minimum value is 1.

• Failure Threshold – When a probe fails, Kubernetes will try failure threshold times before giving up. Giving up in case of a liveness probe means restarting the container. In case of readiness probe, the Pod will be marked Unready. Defaults to 3. The minimum value is 1.

16. Click Next to go to the next step. Click Save & Exit if you want to save as a draft and exit the wizard.

17. Fill the following information. All fields are optional and can be skipped if not required.

• Name (Volume Mount) – Enter the Name of the Volume Mount.

• Path (Volume Mount) – Enter the Path of the Volume Mount.

• You can add more Volume Mounts by clicking the Add button.

• Name (Volume Volumes) – Enter the Name of the Volume Volume.

• Host Path (Volume Volumes) – Enter the Host Path of the Volume Volumes.

• Host Path Type (Volume Volumes) – Select the Host Path Type of the Volume Volumes.

• You can add more Volume Volumes by clicking the Add button.

18. Click Next to add the container. Click Save & Exit if you want to save as a draft and exit the wizard.

19. If you have more images click Yes and follow the steps from step 10 to step 16 above. You can edit the containers by clicking the Edit icon.

20. Once all containers are added, click Next to go to the next step. Click Save & Exit if you want to save as a draft and exit the wizard.

21. Fill the following information.

• Service Name – Enter the Service Name.

• App Selector – Select the App from the list.

• Type – Select the Service Type.

• Name (Ports) – Enter the Name of the Port.

• Port (Ports) – Enter the Port.

• Target Port (Ports) – Enter the Target Port.

• Protocol (Ports) – Enter the Port Protocol.

• Click Add Port button to add another port. Multiple Ports can be added.

• Click Add Service to add another service. Multiple Services can be added.

22. Click Next to go to the next step. Click Save & Exit if you want to save as a draft and exit the wizard.

23. Fill the following information.

• Name – Enter the Ingress Name.

• Host – Enter the Ingress Host.

• Backend Service Name – Enter the Backend Service Name.

• Backend Service Port – Enter the Backend Service Port.

• Click Add Rules button to add another rule. Multiple rules can be added.

• Click Add Ingress to add another ingress. Multiple Ingresses can be added.

24. Click Save & Exit if you want to save the version and exit the wizard.

25. The new version will be saved. A popup will be displayed prompting if you want to publish the new version. Click Yes to publish. Click No to if you want to publish the version later.

26. Once the version is added successfully a small window will appear as below displaying the “Version Added successfully” message.

27. Click May be later to cancel to go next step or click Yes to go to the next step. This will navigate to the Solution canvas page. https://ahasa.io/docs/7-1-creating-a-canvas/

7.6.2 Configuring Endpoints #

1. Login to Ahasa.

2. On the Left Pane, expand Private Catalog and click Product Management.

3. Search and identify the required product. Then expand it and click Endpoints.

4. Fill the following information.

The endpoint details entered on this overlay for a particular product version will be available on the Canvas when the user needs to add integrations when designing solutions.

• Name – Enter the Endpoint Name.

• Endpoint – Enter the Endpoint and click Method.

• Method – Select the Method and click Headers.

• Headers – Enter the Key and Value. Click + to add more. After adding all Headers, then click Authorization.

• Authorization – Enter User Name and Password.

• After filling all the required fields click Add. You can add multiple Endpoints.

5. You can edit, delete or view the added endpoints by using the edit, delete, view respectively.

Importing Endpoints from Older Versions

1. Click the Import dropdown list and select the version from which you want to import the Endpoints.

• All manually entered endpoints will be overridden If imported endpoints from a different version.

2. Once the Endpoints are imported, you can edit, delete or view the added endpoints by using the edit, delete, view respectively.

7.6.3 Editing a Version #

1. Login to Ahasa.

2. On the Left Pane, expand Private Catalog and click Product Management.

3. Search and identify the required product. Then locate the required version and on the Actions column click edit Published versions cannot be edited.

4. Update the required fields and click Update & Exit.

7.6.4 Deleting a Version #

1. Login to Ahasa.

2. On the Left Pane, expand Private Catalog and click Version Management.

3. Search and identify the required product. Then expand the product and click delete on the required version. Published versions cannot be deleted.

4. Click Yes to confirm the deletion.

7.6.5 Publishing a Version #

1. Login to Ahasa.

2. On the Left Pane, expand Private Catalog and click Version Management.

3. Search and identify the required product. Then expand the product and click publish .

4. Click Yes to confirm publishing.

5. Once the version is added successfully a small window will appear as below displaying the “Version Added successfully” message.

6. Click May be later to cancel to go next step or click Yes to go to the next step. This will navigate to the Solution canvas page. https://ahasa.io/docs/7-1-creating-a-canvas/