Skip to content

Commit

Permalink
Merge pull request #1503 from OctopusDeploy/mh/venafi-links
Browse files Browse the repository at this point in the history
Fix broken links on venafi step templates description
  • Loading branch information
twerthi authored Apr 16, 2024
2 parents 4d58406 + e968b77 commit d16c123
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 7 deletions.
8 changes: 4 additions & 4 deletions step-templates/venafi-tpp-create-provision-certificate.json
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
{
"Id": "dd4dfa66-e632-4c6a-bae6-156a7a105023",
"Name": "Venafi TPP - Create and Provision Certificate",
"Description": "This step template will authenticate against a Venafi TPP instance using an existing OAuth access token, and create a new certificate as well as optionally associate and push the new certificate to specified existing application(s). This is achieved using a combination of two functions from the VenafiPS PowerShell module:\n\n1. [New-TppCertificate](https://venafips.readthedocs.io/en/latest/functions/New-TppCertificate/) function.\n2. [Add-TppCertificateAssociation](https://venafips.readthedocs.io/en/latest/functions/Add-TppCertificateAssociation/) function.\n\n---\n\n**Options:**\n\n- Provide a distinguished name (DN) path for the new certificate.\n- Provide a name for the new certificate.\n- Provide a common name (CN) for the new certificate.\n- *Optional* - Provide the distinguished name (DN) path to a certificate authority template to be used for the new certificate.\n- *Optional* - Choose from the following certificate types:\n - `Code Signing`\n - `Device`\n - `Server`\n - `User`\n- *Optional* - Choose from the following certificate management types:\n - `Enrollment`\n - `Provisioning`\n - `Monitoring`\n - `Unassigned`\n- *Optional* - Provide subject alternate names for the new certificate using the following acceptable SAN types: \n - `OtherName`\n - `Email`\n - `DNS`\n - `URI`\n - `IPAdress`\n- *Optional* - Choose if you would like the step to wait for the certificate to finishing provisioning before moving on.\n- *Optional* - Choose the maximum time in seconds that you would like the step to wait for provisioning to finish.\n- *Optional* - Provide the application(s) path to associate the new certificate to.\n- *Optional* - Choose to push the new certificate to the specified application(s).\n- *Optional* - Choose to revoke the access token used on successful completion.\n\n---\n\n**Required:** \n- The `VenafiPS` PowerShell module installed on the deployment target or worker. If the module can't be found, the step will attempt to download a version from the [PowerShell gallery](https://www.powershellgallery.com/packages/VenafiPS).\n\nNotes:\n\n- Tested on Octopus `2021.2`.\n- Tested with VenafiPS `3.1.5`.\n- Tested with both Windows PowerShell and PowerShell Core on Linux.\n",
"Description": "This step template will authenticate against a Venafi TPP instance using an existing OAuth access token, and create a new certificate as well as optionally associate and push the new certificate to specified existing application(s). This is achieved using a combination of two functions from the VenafiPS PowerShell module:\n\n1. `New-TppCertificate` which is an alias of the [New-VdcCertificate](https://venafips.readthedocs.io/en/latest/functions/New-VdcCertificate/) function.\n2. `Add-TppCertificateAssociation` which is an alias of the [Add-VdcCertificateAssociation](https://venafips.readthedocs.io/en/latest/functions/Add-VdcCertificateAssociation/) function.\n\n---\n\n**Options:**\n\n- Provide a distinguished name (DN) path for the new certificate.\n- Provide a name for the new certificate.\n- Provide a common name (CN) for the new certificate.\n- *Optional* - Provide the distinguished name (DN) path to a certificate authority template to be used for the new certificate.\n- *Optional* - Choose from the following certificate types:\n - `Code Signing`\n - `Device`\n - `Server`\n - `User`\n- *Optional* - Choose from the following certificate management types:\n - `Enrollment`\n - `Provisioning`\n - `Monitoring`\n - `Unassigned`\n- *Optional* - Provide subject alternate names for the new certificate using the following acceptable SAN types: \n - `OtherName`\n - `Email`\n - `DNS`\n - `URI`\n - `IPAdress`\n- *Optional* - Choose if you would like the step to wait for the certificate to finishing provisioning before moving on.\n- *Optional* - Choose the maximum time in seconds that you would like the step to wait for provisioning to finish.\n- *Optional* - Provide the application(s) path to associate the new certificate to.\n- *Optional* - Choose to push the new certificate to the specified application(s).\n- *Optional* - Choose to revoke the access token used on successful completion.\n\n---\n\n**Required:** \n- The `VenafiPS` PowerShell module installed on the deployment target or worker. If the module can't be found, the step will attempt to download a version from the [PowerShell gallery](https://www.powershellgallery.com/packages/VenafiPS).\n\nNotes:\n\n- Tested on Octopus `2021.2`.\n- Tested with VenafiPS `3.1.5`.\n- Tested with both Windows PowerShell and PowerShell Core on Linux.\n",
"ActionType": "Octopus.Script",
"Version": 1,
"Version": 2,
"CommunityActionTemplateId": null,
"Packages": [],
"Properties": {
Expand Down Expand Up @@ -160,6 +160,6 @@
"OctopusVersion": "2021.1.7236",
"Type": "ActionTemplate"
},
"LastModifiedBy": "mark-the-butler",
"LastModifiedBy": "harrisonmeister",
"Category": "venafi"
}
}
6 changes: 3 additions & 3 deletions step-templates/venafi-tpp-generate-oauth-token.json
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
{
"Id": "7e6f7f03-260a-4b52-9377-66f1c69b77d8",
"Name": "Venafi TPP - Generate OAuth Token",
"Description": "This step template will authenticate against a Venafi TPP instance and generate an OAuth token for specified scope/privileges using the VenafiPS PowerShell module's [New-TppToken](https://venafips.readthedocs.io/en/latest/functions/New-TppToken/) function.\n\nThe following properties from the resulting OAuth token will be created as [Octopus sensitive variables](https://octopus.com/docs/projects/variables/output-variables#sensitive-output-variables):\n\n- `access_token` created with the name `AccessToken`\n- `Expires` created with the name `AccessTokenExpires` in the format `yyyy-MM-ddTHH:mm:ss`\n- `refresh_token` created with the name `RefreshToken`\n- `refresh_until` created with the name `RefreshTokenExpires` in the format `yyyy-MM-ddTHH:mm:ss`. *Note: This value can be empty*.\n\nThese output variables can be used in additional deployment or runbook steps.\n\n---\n\n**Required:** \n- The `VenafiPS` PowerShell module installed on the deployment target or worker. If the module can't be found, the step will attempt to download a version from the [PowerShell gallery](https://www.powershellgallery.com/packages/VenafiPS).\n\nNotes:\n\n- Tested on Octopus `2021.2`.\n- Tested with VenafiPS `3.1.5`.\n- Tested with both Windows PowerShell and PowerShell Core on Linux.",
"Description": "This step template will authenticate against a Venafi TPP instance and generate an OAuth token for specified scope/privileges using the VenafiPS PowerShell module's `New-TppToken` (an alias of the [VdcToken](https://venafips.readthedocs.io/en/latest/functions/New-VdcToken/) function).\n\nThe following properties from the resulting OAuth token will be created as [Octopus sensitive variables](https://octopus.com/docs/projects/variables/output-variables#sensitive-output-variables):\n\n- `access_token` created with the name `AccessToken`\n- `Expires` created with the name `AccessTokenExpires` in the format `yyyy-MM-ddTHH:mm:ss`\n- `refresh_token` created with the name `RefreshToken`\n- `refresh_until` created with the name `RefreshTokenExpires` in the format `yyyy-MM-ddTHH:mm:ss`. *Note: This value can be empty*.\n\nThese output variables can be used in additional deployment or runbook steps.\n\n---\n\n**Required:** \n- The `VenafiPS` PowerShell module installed on the deployment target or worker. If the module can't be found, the step will attempt to download a version from the [PowerShell gallery](https://www.powershellgallery.com/packages/VenafiPS).\n\nNotes:\n\n- Tested on Octopus `2021.2`.\n- Tested with VenafiPS `3.1.5`.\n- Tested with both Windows PowerShell and PowerShell Core on Linux.",
"ActionType": "Octopus.Script",
"Version": 2,
"Version": 3,
"CommunityActionTemplateId": null,
"Packages": [],
"Properties": {
Expand Down Expand Up @@ -63,7 +63,7 @@
}
}
],
"LastModifiedAt": "2021-07-30T10:36:31.301Z",
"LastModifiedAt": "2024-04-10T17:28:31.301Z",
"LastModifiedBy": "harrisonmeister",
"$Meta": {
"ExportedAt": "2021-07-30T10:36:31.301Z",
Expand Down

0 comments on commit d16c123

Please sign in to comment.