From 1eec65f699ae9c8cd8a9418d387b5b42eb82e410 Mon Sep 17 00:00:00 2001 From: Macey Dobrowsky <11599974+doebrowsk@users.noreply.github.com> Date: Tue, 5 Nov 2024 12:21:40 -0500 Subject: [PATCH 1/2] use restore-doctool RC build --- .github/workflows/keyfactor-starter-workflow.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/keyfactor-starter-workflow.yml b/.github/workflows/keyfactor-starter-workflow.yml index 0093d2c..729a5a2 100644 --- a/.github/workflows/keyfactor-starter-workflow.yml +++ b/.github/workflows/keyfactor-starter-workflow.yml @@ -11,7 +11,7 @@ on: jobs: call-starter-workflow: - uses: keyfactor/actions/.github/workflows/starter.yml@3.1.1 + uses: keyfactor/actions/.github/workflows/starter.yml@3.1.2-rc.0 secrets: token: ${{ secrets.V2BUILDTOKEN}} APPROVE_README_PUSH: ${{ secrets.APPROVE_README_PUSH}} From 9cefe534eb1768dfa475cfe36b99bac4d8b5a6ed Mon Sep 17 00:00:00 2001 From: Keyfactor Date: Tue, 5 Nov 2024 17:23:11 +0000 Subject: [PATCH 2/2] Update generated docs --- README.md | 78 ++++++++++++------------------------------ docsource/citrixadc.md | 20 +++++++++++ 2 files changed, 42 insertions(+), 56 deletions(-) create mode 100644 docsource/citrixadc.md diff --git a/README.md b/README.md index 8fdee6b..002bd46 100644 --- a/README.md +++ b/README.md @@ -35,6 +35,11 @@ The Citrix ADC Orchestrator remotely manages certificate objects on a Citrix ADC Load Balancing, Authentication/Authorization/Auditing (AAA), and Gateways, this orchestrator can bind to any of these virtual servers when using unique virtual server names for each service. +### CitrixAdc +TODO Global Store Type Section is an optional section. If this section doesn't seem necessary on initial glance, please delete it. Refer to the docs on [Confluence](https://keyfactor.atlassian.net/wiki/x/SAAyHg) for more info + + +TODO Overview is a required section ## Compatibility @@ -66,12 +71,22 @@ Allow * Command Spec: (^stat\s+(cr|cs|lb|system|vpn))|(^(add|rm|show)\s+system\s+file\s+.*)|(^\S+\s+ssl\s+.*)|(^(show|stat|sync)\s+HA\s+.*)|(^save\s+ns\s+config)|(^(switch|show)\s+ns\s+partition.*) +### CitrixAdc Requirements +TODO Global Store Type Section is an optional section. If this section doesn't seem necessary on initial glance, please delete it. Refer to the docs on [Confluence](https://keyfactor.atlassian.net/wiki/x/SAAyHg) for more info + + +TODO Requirements is an optional section. If this section doesn't seem necessary on initial glance, please delete it. Refer to the docs on [Confluence](https://keyfactor.atlassian.net/wiki/x/SAAyHg) for more info + + + ## Create the CitrixAdc Certificate Store Type To use the Citrix Netscaler Universal Orchestrator extension, you **must** create the CitrixAdc Certificate Store Type. This only needs to happen _once_ per Keyfactor Command instance. +TODO Global Store Type Section is an optional section. If this section doesn't seem necessary on initial glance, please delete it. Refer to the docs on [Confluence](https://keyfactor.atlassian.net/wiki/x/SAAyHg) for more info + * **Create CitrixAdc using kfutil**: @@ -123,8 +138,6 @@ To use the Citrix Netscaler Universal Orchestrator extension, you **must** creat | Name | Display Name | Description | Type | Default Value/Options | Required | | ---- | ------------ | ---- | --------------------- | -------- | ----------- | | linkToIssuer | Link To Issuer | Determines whether an attempt will be made to link the added certificate (via a Management-Add job) to its issuing CA certificate. | Bool | false | 🔲 Unchecked | - | ServerUsername | Server Username | The username credential for authenticating against the Citrix ADC (NetScaler) appliance. Example: admin. | Secret | | 🔲 Unchecked | - | ServerPassword | Server Password | The password credential associated with the username for authenticating against the Citrix ADC (NetScaler) appliance. Example: Pa$$w0rd. | Secret | | 🔲 Unchecked | The Custom Fields tab should look like this: @@ -195,69 +208,22 @@ An optional config.json configuration file has been provided in the extensions f ## Defining Certificate Stores +TODO Global Store Type Section is an optional section. If this section doesn't seem necessary on initial glance, please delete it. Refer to the docs on [Confluence](https://keyfactor.atlassian.net/wiki/x/SAAyHg) for more info -* **Manually with the Command UI** - -
Create Certificate Stores manually in the UI - - 1. **Navigate to the _Certificate Stores_ page in Keyfactor Command.** - - Log into Keyfactor Command, toggle the _Locations_ dropdown, and click _Certificate Stores_. - - 2. **Add a Certificate Store.** +TODO Certificate Store Configuration is an optional section. If this section doesn't seem necessary on initial glance, please delete it. Refer to the docs on [Confluence](https://keyfactor.atlassian.net/wiki/x/SAAyHg) for more info - Click the Add button to add a new Certificate Store. Use the table below to populate the **Attributes** in the **Add** form. - | Attribute | Description | - | --------- | ----------- | - | Category | Select "CitrixAdc" or the customized certificate store name from the previous step. | - | Container | Optional container to associate certificate store with. | - | Client Machine | The DNS or IP Address of the Citrix ADC Appliance. | - | Store Path | The path where certificate files are located on the Citrix ADC appliance. This value will likely be /nsconfig/ssl/ | - | Orchestrator | Select an approved orchestrator capable of managing `CitrixAdc` certificates. Specifically, one with the `CitrixAdc` capability. | - | linkToIssuer | Determines whether an attempt will be made to link the added certificate (via a Management-Add job) to its issuing CA certificate. | - | ServerUsername | The username credential for authenticating against the Citrix ADC (NetScaler) appliance. Example: admin. | - | ServerPassword | The password credential associated with the username for authenticating against the Citrix ADC (NetScaler) appliance. Example: Pa$$w0rd. | - - -
- -* **Using kfutil** - -
Create Certificate Stores with kfutil - - 1. **Generate a CSV template for the CitrixAdc certificate store** - - ```shell - kfutil stores import generate-template --store-type-name CitrixAdc --outpath CitrixAdc.csv - ``` - 2. **Populate the generated CSV file** - - Open the CSV file, and reference the table below to populate parameters for each **Attribute**. - | Attribute | Description | - | --------- | ----------- | - | Category | Select "CitrixAdc" or the customized certificate store name from the previous step. | - | Container | Optional container to associate certificate store with. | - | Client Machine | The DNS or IP Address of the Citrix ADC Appliance. | - | Store Path | The path where certificate files are located on the Citrix ADC appliance. This value will likely be /nsconfig/ssl/ | - | Orchestrator | Select an approved orchestrator capable of managing `CitrixAdc` certificates. Specifically, one with the `CitrixAdc` capability. | - | linkToIssuer | Determines whether an attempt will be made to link the added certificate (via a Management-Add job) to its issuing CA certificate. | - | ServerUsername | The username credential for authenticating against the Citrix ADC (NetScaler) appliance. Example: admin. | - | ServerPassword | The password credential associated with the username for authenticating against the Citrix ADC (NetScaler) appliance. Example: Pa$$w0rd. | +> The content in this section can be supplimented by the [official Command documentation](https://software.keyfactor.com/Core-OnPrem/Current/Content/ReferenceGuide/Certificate%20Stores.htm?Highlight=certificate%20store). - +## Discovering Certificate Stores with the Discovery Job - 3. **Import the CSV file to create the certificate stores** +### CitrixAdc Discovery Job +TODO Global Store Type Section is an optional section. If this section doesn't seem necessary on initial glance, please delete it. Refer to the docs on [Confluence](https://keyfactor.atlassian.net/wiki/x/SAAyHg) for more info - ```shell - kfutil stores import csv --store-type-name CitrixAdc --file CitrixAdc.csv - ``` -
- -> The content in this section can be supplimented by the [official Command documentation](https://software.keyfactor.com/Core-OnPrem/Current/Content/ReferenceGuide/Certificate%20Stores.htm?Highlight=certificate%20store). +TODO Discovery Job Configuration is an optional section. If this section doesn't seem necessary on initial glance, please delete it. Refer to the docs on [Confluence](https://keyfactor.atlassian.net/wiki/x/SAAyHg) for more info diff --git a/docsource/citrixadc.md b/docsource/citrixadc.md new file mode 100644 index 0000000..d53d056 --- /dev/null +++ b/docsource/citrixadc.md @@ -0,0 +1,20 @@ +## Overview + +TODO Overview is a required section + +## Requirements + +TODO Requirements is an optional section. If this section doesn't seem necessary on initial glance, please delete it. Refer to the docs on [Confluence](https://keyfactor.atlassian.net/wiki/x/SAAyHg) for more info + +## Discovery Job Configuration + +TODO Discovery Job Configuration is an optional section. If this section doesn't seem necessary on initial glance, please delete it. Refer to the docs on [Confluence](https://keyfactor.atlassian.net/wiki/x/SAAyHg) for more info + +## Certificate Store Configuration + +TODO Certificate Store Configuration is an optional section. If this section doesn't seem necessary on initial glance, please delete it. Refer to the docs on [Confluence](https://keyfactor.atlassian.net/wiki/x/SAAyHg) for more info + +## Global Store Type Section + +TODO Global Store Type Section is an optional section. If this section doesn't seem necessary on initial glance, please delete it. Refer to the docs on [Confluence](https://keyfactor.atlassian.net/wiki/x/SAAyHg) for more info +