paulononato/backstage
1
0
Fork 0
Code Issues Pull Requests Actions 21 Packages Projects Releases Wiki Activity

Fix docs

Browse Source 
Signed-off-by: Jonathan Mezach <jonathan.mezach@rr-wfm.com>
This commit is contained in:
Jonathan Mezach
2023-05-02 13:03:30 +02:00
parent 92c40cf186
commit 31c872ed7c
1 changed files with 18 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files
plugins/octopus-deploy/README.md
+18 -2
View File
@@ -42,9 +42,9 @@ const cicdContent = (
)
```
3. Add `octopus.com/project-id` and optionally an `octopus.com/space-id` annotation in the catalog descriptor file.
3. Add `octopus.com/project-id` annotation in the catalog descriptor file.
To obtain a projects ID you will have to query the Octopus API. You can get the space ID from the projects URL in the octopus deploy UI. In the future we'll add support for using a projects slug as well.
To obtain a projects ID you will have to query the Octopus API. In the future we'll add support for using a projects slug as well.
```
// catalog-info.yaml
@@ -58,4 +58,20 @@ spec:
type: service
```
If your project is not part of the default space you can add the space ID to the annotation as a prefix. For example:
```
// catalog-info.yaml
apiVersion: backstage.io/v1alpha1
kind: Component
metadata:
# ...
annotations:
octopus.com/project-id: Spaces-2/Projects-102
spec:
type: service
```
You can get the ID of the space from the URL in the Octopus Deploy UI.
All set, you will be able to see the plugin in action!