Skip to content

Commit ded5dee

Browse files
ansvuansvu
committed
update readme of container to pipeline
1 parent 2c3e9e8 commit ded5dee

File tree

2 files changed

+467
-259
lines changed

2 files changed

+467
-259
lines changed

‎roles/create_certification_project/README.md

+98-77
Original file line numberDiff line numberDiff line change
@@ -55,86 +55,107 @@ privileged | false | false or tru
5555
repository_description | "Add a description of project here" | This will be displayed on the container catalog repository overview page.
5656

5757

58-
## Example of configuration file
58+
## Configuration Example of Operator and Container
59+
This is an example where pipeline configs are saved in `my-dci-pipeline-test/pipelines` folder.
5960

6061
```yaml
61-
$ cat /etc/dci-openshift-app-agent/settings.yml
62+
$ cat my-dci-pipeline-test/pipelines/testpmd-operator-container-pipeline.yml
6263
---
63-
# job name and tags to be displayed in DCI UI
64-
dci_name: "Testpmd-Operator-Preflight"
65-
dci_tags: ["debug", "testpmd-operator", "testpmd-container"]
66-
dci_topic: "OCP-4.7"
67-
# DCI component for every OCP version
68-
# could be checked here: https://www.distributed-ci.io/topics
69-
dci_component: ['8cef32d9-bb90-465f-9b42-8b058878780a']
70-
71-
# Optional, please provide these credentials
72-
# if your registry is private.
73-
partner_creds: "/opt/pull-secrets/partner_config.json"
74-
75-
# Optional; provide it when you need to submit test results.
76-
# This token is shared between all your projects.
77-
# To generate it: connect.redhat.com -> Product certification ->
78-
# Container API Keys -> Generate new key
79-
pyxis_apikey_path: "/opt/cache/pyxis-apikey.txt"
80-
81-
# Required to create and update cert projects.
82-
# Check the instructions below on where to retrieve it
83-
organization_id: "12345678"
84-
85-
# Optional; provide this token when using create_pr option
86-
# while creating operator or helm-chart project
87-
# Check the instructions below on how to create it
88-
github_token_path: "/opt/cache/dcicertbot-token.txt"
89-
90-
# List of operators to certify,
91-
# you could provide many operators at once.
92-
preflight_operators_to_certify:
93-
- bundle_image: "quay.io/rh-nfv-int/bla-bla-bundle:v0.2.1"
94-
# Mandatory for the connected environments.
95-
index_image: "quay.io/rh-nfv-int/bla-bla-catalog:v0.2.1"
96-
# Optional; provide it when you need to create
97-
# a new "Container Image project" and submit test results in it.
98-
create_container_project: true
99-
# Optional; provide it when you need to create
100-
# a new "Operator Bundle Image" and submit test results in it.
101-
create_operator_project: true
102-
# Required when creating cert project
103-
short_description: "Add 50+ characters image description here"
104-
# Optional; use it to automatically open cert PR
105-
# at the certified-operators repository
106-
create_pr: true
107-
# Product Listings to attach to the cert project (Optional)
108-
pyxis_product_lists:
109-
- "yyy"
110-
- "xxx"
111-
112-
# List of container images to certify,
113-
# you could provide multiple images to certify at once.
114-
preflight_containers_to_certify:
115-
- container_image: "quay.io/my-container/bla-bla-image:v0.0.1"
116-
create_container_project: true
117-
# Required when creating cert project
118-
short_description: "Add 50+ characters image description here"
119-
# Product Listings to attach to the cert project (Optional)
120-
pyxis_product_lists:
121-
- "yyy"
122-
- "xxx"
123-
124-
# Project certification setting (Optional)
125-
# This allows to fill the rest of the project settings after project creation
126-
# Any project for containers images certifications can use them
127-
# TODO: provide cert_settings example for every project type
128-
cert_settings:
129-
auto_publish: false
130-
build_categories: "Standalone image"
131-
registry_override_instruct: "These are instructions of how to override settings"
132-
email_address: "[email protected]"
133-
application_categories: "Networking"
134-
os_content_type: "Red Hat Universal Base Image (UBI)"
135-
privileged: false
136-
release_category: "Generally Available"
137-
repository_description: "This is a test repository"
64+
# Generic DCI Pipeline config
65+
- name: testpmd-operator-container
66+
stage: workload
67+
topic: OCP-4.14
68+
ansible_playbook: /usr/share/dci-openshift-app-agent/dci-openshift-app-agent.yml
69+
ansible_cfg: /var/lib/dci-openshift-app-agent/my-dci-pipeline-test/pipelines/ansible.cfg
70+
ansible_inventory: /var/lib/dci-openshift-app-agent/my-dci-pipeline-test/inventories/@QUEUE/@RESOURCE-workload.yml
71+
dci_credentials: /var/lib/dci-openshift-app-agent/.config/dci-pipeline/dci_credentials.yml
72+
ansible_extravars:
73+
dci_cache_dir: /var/lib/dci-openshift-app-agent/dci-cache-dir
74+
dci_config_dir: /var/lib/dci-openshift-app-agent/my-dci-pipeline-test/ocp-workload
75+
dci_gits_to_components:
76+
- /var/lib/dci-openshift-app-agent/my-dci-pipeline-test
77+
dci_local_log_dir: /var/lib/dci-openshift-app-agent/upload-errors
78+
dci_tags: ["debug", "testpmd-operator", "testpmd-container"]
79+
dci_workarounds: []
80+
81+
# Required to create and update cert projects.
82+
# Check the instructions below on where to retrieve it
83+
organization_id: "12345678"
84+
85+
# Reduce the job duration
86+
do_must_gather: false
87+
check_workload_api: false
88+
preflight_run_health_check: false
89+
90+
# Optional, please provide these credentials
91+
# if your registry is private.
92+
partner_creds: "/opt/pull-secrets/partner_config.json"
93+
94+
# Optional; provide it when you need to submit test results.
95+
# This token is shared between all your projects.
96+
# To generate it: connect.redhat.com -> Product certification ->
97+
# Container API Keys -> Generate new key
98+
pyxis_apikey_path: "/opt/cache/pyxis-apikey.txt"
99+
100+
# Optional; provide this token when using create_pr option
101+
# while creating operator or helm-chart project
102+
# Check the instructions below on how to create it
103+
github_token_path: "/opt/cache/dcicertbot-token.txt"
104+
105+
# List of operators to certify,
106+
# you could provide many operators at once.
107+
preflight_operators_to_certify:
108+
- bundle_image: "quay.io/rh-nfv-int/bla-bla-bundle:v0.2.1"
109+
# Mandatory for the connected environments.
110+
index_image: "quay.io/rh-nfv-int/bla-bla-catalog:v0.2.1"
111+
# Optional; provide it when you need to create
112+
# a new "Container Image project" and submit test results in it.
113+
create_container_project: true
114+
# Optional; provide it when you need to create
115+
# a new "Operator Bundle Image" and submit test results in it.
116+
create_operator_project: true
117+
# Required when creating cert project
118+
short_description: "Add 50+ characters image description here"
119+
# Optional; use it to automatically open cert PR
120+
# at the certified-operators repository
121+
create_pr: true
122+
# Product Listings to attach to the cert project (Optional)
123+
pyxis_product_lists:
124+
- "yyy"
125+
- "xxx"
126+
127+
# List of container images to certify,
128+
# you could provide multiple images to certify at once.
129+
preflight_containers_to_certify:
130+
- container_image: "quay.io/my-container/bla-bla-image:v0.0.1"
131+
create_container_project: true
132+
# Required when creating cert project
133+
short_description: "Add 50+ characters image description here"
134+
# Product Listings to attach to the cert project (Optional)
135+
pyxis_product_lists:
136+
- "yyy"
137+
- "xxx"
138+
139+
# Project certification setting (Optional)
140+
# This allows to fill the rest of the project settings after project creation
141+
# Any project for containers images certifications can use them
142+
# TODO: provide cert_settings example for every project type
143+
cert_settings:
144+
# Operator and Container
145+
auto_publish: false
146+
registry_override_instruct: "These are instructions of how to override settings"
147+
email_address: "[email protected]"
148+
application_categories: "Networking"
149+
privileged: false
150+
repository_description: "This is a test repository"
151+
build_categories: "Standalone image"
152+
os_content_type: "Red Hat Universal Base Image (UBI)"
153+
release_category: "Generally Available"
154+
155+
use_previous_topic: true
156+
inputs:
157+
kubeconfig: kubeconfig_path
158+
...
138159
```
139160

140161
## GitHub token

0 commit comments

Comments
 (0)