/alteon-orchestrator

An Orchestrator extension to manage certificates in an instance of the Alteon Load Balancer.

Primary LanguageC#

Orchestrator Extension for Alteon Load Balancer

The Alteon Load Balancer integration allows you to manage certificates within the Alteon Load Balancer device.

Integration status: Production - Ready for use in production environments.

About the Keyfactor Universal Orchestrator Capability

This repository contains a Universal Orchestrator Capability which is a plugin to the Keyfactor Universal Orchestrator. Within the Keyfactor Platform, Orchestrators are used to manage “certificate stores” — collections of certificates and roots of trust that are found within and used by various applications.

The Universal Orchestrator is part of the Keyfactor software distribution and is available via the Keyfactor customer portal. For general instructions on installing Capabilities, see the “Keyfactor Command Orchestrator Installation and Configuration Guide” section of the Keyfactor documentation. For configuration details of this specific Capability, see below in this readme.

The Universal Orchestrator is the successor to the Windows Orchestrator. This Capability plugin only works with the Universal Orchestrator and does not work with the Windows Orchestrator.

Support for Orchestrator Extension for Alteon Load Balancer

Orchestrator Extension for Alteon Load Balancer is supported by Keyfactor for Keyfactor customers. If you have a support issue, please open a support ticket with your Keyfactor representative.

To report a problem or suggest a new feature, use the Issues tab. If you want to contribute actual bug fixes or proposed enhancements, use the Pull requests tab.

Platform Specific Notes

The Keyfactor Universal Orchestrator may be installed on either Windows or Linux based platforms. The certificate operations supported by a capability may vary based what platform the capability is installed on. The table below indicates what capabilities are supported based on which platform the encompassing Universal Orchestrator is running.

Operation Win Linux
Supports Management Add ✓ ✓
Supports Management Remove ✓ ✓
Supports Create Store
Supports Discovery
Supports Renrollment
Supports Inventory ✓ ✓

Setup and Configuration

The high level steps required to configure the Alteon Load Balancer Orchestrator extension are:

  1. Create the Store Type in Keyfactor

  2. Install the Extension on the Orchestrator

  3. Create the Certificate Store

Create the Store Type in Keyfactor

Now we can navigate to the Keyfactor platform and create the store type for the extension.

  1. Navigate to your instance of Keyfactor and log in with a user that has Administrator priveledges.

  2. Click on the gear icon in the top left and navigate to "Certificate Store Types".

    Cert Store Types Menu

  3. Click "Add" to open the Add Certificate Store dialog.

  4. Name the new store type "Alteon Load Balancer" and give it the short name of "AlteonLB".

  5. The Alteon Load Balancer integration supports the following job types: Inventory, Add, Remove. Select from these the capabilities you would like to utilize.

  6. Make sure that "Needs Server" is checked.

    Cert Store Types Menu

  7. Set the following values on the Advanced tab:

    1. Supports Custom Alias - Optional
    2. Private Key Handling - Optional

    Cert Store Types Advanced

  8. No changes are needed in the Custom Fields and Entry Parameters tabs.

Install the Extension on the Orchestrator

The process for installing an extension for the universal orchestrator differs from the process of installing an extension for the Windows orchestrator. Follow the below steps to register the integration with your instance of the universal orchestrator.

  1. Stop the Universal Orchestrator service.

    1. Note: In Windows, this service is called "Keyfactor Orchestrator Service (Default)"

  2. Create a folder in the "extensions" folder of the Universal Orchestrator installation folder named "AlteonLB"

    1. example: `C:\Program Files\Keyfactor\Keyfactor Orchestrator\AlteonLB

  3. Copy the build output (if you compiled from source) or the contents of the zip file (if you downloaded the pre-compiled binaries) into this folder.

  4. Start the Universal Orchestrator Service

Create the certificate store

Now add the certificate store that corresponds to an instance of the Alteon Load Balancer.

The steps to do this are:

  1. Navigate to "Locations > Certificate Stores"

  2. Click "ADD"

    Approve Cert Store

  3. Enter the values corresponding to the Alteon Load Balancer instance.

  • Category: Alteon Load Balancer

  • Container: optional logical container in keyfactor for the certificates from this store

  • Client Machine: The Alteon Load Balancer Server and port

    • Note: The server credentials will only have to be entered once, even if adding multiple certificate stores.
      • Set the credentials to those of the account with sufficient permissions to manage certs in the Alteon Load Balancer.
      • Check Use SSL
      • The Server Name should be the fully qualified URL and port of the Alteon Load Balancer instance.

Server Credentials

  • Store Path: This value isn't used for this integration (other than to uniquely identify the cert store in certificate searches).

License

Apache