Skip to content

Commit 9b64e45

Browse files
committed
chore(git): Merge branch 'certauth-kvsecretversion-57240' of github.com:Keyfactor/azure-appgateway-orchestrator into certauth-kvsecretversion-57240
2 parents 9729442 + 526e083 commit 9b64e45

File tree

1 file changed

+57
-9
lines changed

1 file changed

+57
-9
lines changed

README.md

+57-9
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,53 @@
1+
2+
# Azure Application Gateway Orchestrator
3+
4+
The Azure Application Gateway Orchestrator Extension is an extension to the Keyfactor Universal Orchestrator that allows for the management of certificates on Azure Application Gateways, including the ability to add and bind certificates to HTTPS listeners.
5+
6+
#### Integration status: Production - Ready for use in production environments.
7+
8+
## About the Keyfactor Universal Orchestrator Extension
9+
10+
This repository contains a Universal Orchestrator Extension 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.
11+
12+
The Universal Orchestrator is part of the Keyfactor software distribution and is available via the Keyfactor customer portal. For general instructions on installing Extensions, see the “Keyfactor Command Orchestrator Installation and Configuration Guide” section of the Keyfactor documentation. For configuration details of this specific Extension see below in this readme.
13+
14+
The Universal Orchestrator is the successor to the Windows Orchestrator. This Orchestrator Extension plugin only works with the Universal Orchestrator and does not work with the Windows Orchestrator.
15+
16+
## Support for Azure Application Gateway Orchestrator
17+
18+
Azure Application Gateway Orchestrator is supported by Keyfactor for Keyfactor customers. If you have a support issue, please open a support ticket via the Keyfactor Support Portal at https://support.keyfactor.com
19+
20+
###### To report a problem or suggest a new feature, use the **[Issues](../../issues)** tab. If you want to contribute actual bug fixes or proposed enhancements, use the **[Pull requests](../../pulls)** tab.
21+
22+
---
23+
24+
25+
---
26+
27+
28+
29+
## Keyfactor Version Supported
30+
31+
The minimum version of the Keyfactor Universal Orchestrator Framework needed to run this version of the extension is 10.4
32+
## Platform Specific Notes
33+
34+
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.
35+
| Operation | Win | Linux |
36+
|-----|-----|------|
37+
|Supports Management Add|✓ |✓ |
38+
|Supports Management Remove|✓ |✓ |
39+
|Supports Create Store| | |
40+
|Supports Discovery|✓ |✓ |
41+
|Supports Reenrollment| | |
42+
|Supports Inventory|✓ |✓ |
43+
44+
45+
46+
47+
48+
---
49+
50+
151
<h1 align="center" style="border-bottom: none">
252
Azure Application Gateway Universal Orchestrator Extension
353
</h1>
@@ -37,14 +87,6 @@ The Azure Application Gateway Orchestrator extension remotely manages certificat
3787
>
3888
> If the certificate management capabilities of Azure Key Vault are desired over direct management of certificates in Application Gateways, the Azure Key Vault orchestrator can be used in conjunction with this extension for accurate certificate location reporting via the inventory job type. This management strategy requires manual binding of certificates imported to an Application Gateway from AKV and can result in broken state in the Azure Application Gateway in the case that the secret is deleted in AKV.
3989
40-
## Compatibility
41-
42-
This integration is compatible with Keyfactor Universal Orchestrator version 10.4 and later.
43-
44-
## Support
45-
The Azure Application Gateway Universal Orchestrator extension is supported by Keyfactor for Keyfactor customers. If you have a support issue, please open a support ticket with your Keyfactor representative. If you have a support issue, please open a support ticket via the Keyfactor Support Portal at https://support.keyfactor.com.
46-
47-
> To report a problem or suggest a new feature, use the **[Issues](../../issues)** tab. If you want to contribute actual bug fixes or proposed enhancements, use the **[Pull requests](../../pulls)** tab.
4890

4991
## Installation
5092
Before installing the Azure Application Gateway Universal Orchestrator extension, it's recommended to install [kfutil](https://github.com/Keyfactor/kfutil). Kfutil is a command-line tool that simplifies the process of creating store types, installing extensions, and instantiating certificate stores in Keyfactor Command.
@@ -59,6 +101,7 @@ The Azure Application Gateway Universal Orchestrator extension implements 2 Cert
59101
1. Follow the [requirements section](docs/azureappgw.md#requirements) to configure a Service Account and grant necessary API permissions.
60102

61103
<details><summary>Requirements</summary>
104+
62105
### Azure Service Principal (Azure Resource Manager Authentication)
63106

64107
The Azure Application Gateway Orchestrator extension uses an [Azure Service Principal](https://learn.microsoft.com/en-us/entra/identity-platform/app-objects-and-service-principals?tabs=browser) for authentication. Follow [Microsoft's documentation](https://learn.microsoft.com/en-us/entra/identity-platform/howto-create-service-principal-portal) to create a service principal.
@@ -170,6 +213,7 @@ The Azure Application Gateway Universal Orchestrator extension implements 2 Cert
170213
1. Follow the [requirements section](docs/appgwbin.md#requirements) to configure a Service Account and grant necessary API permissions.
171214

172215
<details><summary>Requirements</summary>
216+
173217
### Azure Service Principal (Azure Resource Manager Authentication)
174218

175219
The Azure Application Gateway Orchestrator extension uses an [Azure Service Principal](https://learn.microsoft.com/en-us/entra/identity-platform/app-objects-and-service-principals?tabs=browser) for authentication. Follow [Microsoft's documentation](https://learn.microsoft.com/en-us/entra/identity-platform/howto-create-service-principal-portal) to create a service principal.
@@ -282,4 +326,8 @@ Apache License 2.0, see [LICENSE](LICENSE).
282326

283327
## Related Integrations
284328

285-
See all [Keyfactor Universal Orchestrator extensions](https://github.com/orgs/Keyfactor/repositories?q=orchestrator).
329+
See all [Keyfactor Universal Orchestrator extensions](https://github.com/orgs/Keyfactor/repositories?q=orchestrator).
330+
331+
When creating cert store type manually, that store property names and entry parameter names are case sensitive
332+
333+

0 commit comments

Comments
 (0)