diff --git a/README.rst b/README.rst index 56a135da..83fc9dfa 100644 --- a/README.rst +++ b/README.rst @@ -31,9 +31,10 @@ the entire OpenStack ecosystem. It can also be used to validate clouds against existing capability lists, giving you assurance that your cloud faithfully implements OpenStack standards. -**Value add for vendors** - Vendors can use RefStack to demonstrate that -their distros, and/or their customers' installed clouds remain with OpenStack -after their software has been incorporated into the distro or cloud. +**Value add for openstack distro or solution vendors** - Vendors can use +RefStack to demonstrate that their distros, and/or their customers' installed +clouds remain OpenStack compliant after their software has been incorporated +into the distro or cloud. **RefStack consists of two parts:** @@ -42,16 +43,17 @@ after their software has been incorporated into the distro or cloud. vendors. It can be used by vendors in house to compare interoperability data over time. - * API and UI install docs: https://opendev.org/osf/refstack/src/master/doc/source/refstack.rst - * repository: https://opendev.org/osf/refstack - * reviews: https://review.opendev.org/#/q/status:open+project:osf/refstack + * documentation: https://docs.opendev.org/openinfra/refstack/latest/ + * repository: https://opendev.org/openinfra/refstack + * reviews: https://review.opendev.org/#/q/status:open+project:openinfra/refstack * **refstack-client** refstack-client contains the tools you will need to run the Interop Working Group tests. - * repository: https://opendev.org/osf/refstack-client - * reviews: https://review.opendev.org/#/q/status:open+project:osf/refstack-client + * documentation: https://docs.opendev.org/openinfra/refstack-client/latest/ + * repository: https://opendev.org/openinfra/refstack-client + * reviews: https://review.opendev.org/#/q/status:open+project:openinfra/refstack-client Get involved! ############# diff --git a/doc/source/README.rst b/doc/source/README.rst deleted file mode 120000 index c768ff7d..00000000 --- a/doc/source/README.rst +++ /dev/null @@ -1 +0,0 @@ -../../README.rst \ No newline at end of file diff --git a/doc/source/README.rst b/doc/source/README.rst new file mode 100644 index 00000000..83fc9dfa --- /dev/null +++ b/doc/source/README.rst @@ -0,0 +1,65 @@ +======== +RefStack +======== + +What is RefStack? +################# + +- Toolset for testing interoperability between OpenStack clouds. +- Database backed website supporting collection and publication of + Community Test results for OpenStack. +- User interface to display individual test run results. + +Overview +######## + +RefStack intends on being THE source of tools for interoperability testing +of OpenStack clouds. + +RefStack provides users in the OpenStack community with a Tempest wrapper, +refstack-client, that helps to verify interoperability of their cloud +with other OpenStack clouds. It does so by validating any cloud +implementation against the OpenStack Tempest API tests. + +**RefStack and Interop Working Group** - The prototypical use case for RefStack +provides the Interop Working Group - formerly known as DefCore committee - the +tools for vendors and other users to run API tests against their clouds to +provide the WG with a reliable overview of what APIs and capabilities are +being used in the marketplace. This will help to guide the Interop +Working Group defined capabilities and help ensure interoperability across +the entire OpenStack ecosystem. It can also be used to validate clouds +against existing capability lists, giving you assurance that your cloud +faithfully implements OpenStack standards. + +**Value add for openstack distro or solution vendors** - Vendors can use +RefStack to demonstrate that their distros, and/or their customers' installed +clouds remain OpenStack compliant after their software has been incorporated +into the distro or cloud. + +**RefStack consists of two parts:** + +* **refstack-api** + Our API isn't just for us to collect data from private and public cloud + vendors. It can be used by vendors in house to compare interoperability + data over time. + + * documentation: https://docs.opendev.org/openinfra/refstack/latest/ + * repository: https://opendev.org/openinfra/refstack + * reviews: https://review.opendev.org/#/q/status:open+project:openinfra/refstack + +* **refstack-client** + refstack-client contains the tools you will need to run the + Interop Working Group tests. + + * documentation: https://docs.opendev.org/openinfra/refstack-client/latest/ + * repository: https://opendev.org/openinfra/refstack-client + * reviews: https://review.opendev.org/#/q/status:open+project:openinfra/refstack-client + +Get involved! +############# + +* Mailing List: openstack-discuss@lists.openstack.org +* IRC: #refstack on OFTC +* Wiki: https://wiki.openstack.org/wiki/Governance/InteropWG +* Meetings: See the wiki page for meeting info +* Web-site: https://refstack.openstack.org diff --git a/doc/source/refstack.rst b/doc/source/refstack.rst index ccabfcb1..dbe382eb 100644 --- a/doc/source/refstack.rst +++ b/doc/source/refstack.rst @@ -57,7 +57,7 @@ Clone the repository ^^^^^^^^^^^^^^^^^^^^ :: - git clone https://opendev.org/osf/refstack + git clone https://opendev.org/openinfra/refstack cd refstack **Create virtual environment**:: @@ -178,7 +178,7 @@ above. RefStack, by default, points to this endpoint. Instructions for setting this up are outside of the scope of this doc, but you can get started at -`Openstackid project `__ . +`Openstackid project `__ . You would then need to modify the ``openstack_openid_endpoint`` field in the ``[osid]`` section in refstack.conf to match the local endpoint. diff --git a/doc/source/run_in_docker/Option1AnsiblePlaybook.rst b/doc/source/run_in_docker/Option1AnsiblePlaybook.rst index bc39f038..7752e2a8 100644 --- a/doc/source/run_in_docker/Option1AnsiblePlaybook.rst +++ b/doc/source/run_in_docker/Option1AnsiblePlaybook.rst @@ -70,12 +70,12 @@ Go to the location where the playbook downloaded system-config, default in Replace:: - $ RUN git clone https://opendev.org/osf/refstack /tmp/src + $ RUN git clone https://opendev.org/openinfra/refstack /tmp/src by:: - $ RUN git clone https://opendev.org/osf/refstack.git /tmp/src \ - && cd /tmp/src && git fetch "https://review.opendev.org/osf/refstack" \ + $ RUN git clone https://opendev.org/openinfra/refstack.git /tmp/src \ + && cd /tmp/src && git fetch "https://review.opendev.org/openinfra/refstack" \ refs/changes/37/ && git checkout -b \ change-- FETCH_HEAD diff --git a/doc/source/uploading_private_results.rst b/doc/source/uploading_private_results.rst index cf336fb6..bdc02a0c 100644 --- a/doc/source/uploading_private_results.rst +++ b/doc/source/uploading_private_results.rst @@ -53,11 +53,11 @@ Sign Key with RefStack Client **IMPORTANT** You must have the RefStack client on you computer to complete this step. -Follow `its README `__ on how to +Follow `its README `__ on how to install it. Generate a signature for your public key using your private key with -`refstack-client `__:: +`refstack-client `__:: $ ./refstack-client sign /path-of-sshkey-folder/key-file-name diff --git a/etc/refstack.conf.sample b/etc/refstack.conf.sample index 9416bcb6..c37ae671 100644 --- a/etc/refstack.conf.sample +++ b/etc/refstack.conf.sample @@ -210,17 +210,17 @@ # The GitHub API URL of the repository and location of the Interop # Working Group capability files. This URL is used to get a listing of # all capability files. (string value) -#opendev_api_capabilities_url = https://opendev.org/api/v1/repos/osf/interop/contents/guidelines +#opendev_api_capabilities_url = https://opendev.org/api/v1/repos/openinfra/interop/contents/guidelines # The GitHub API URL of the repository and location of any additional # guideline sources which will need to be parsed by the refstack API. # (string value) -#additional_capability_urls = https://opendev.org/api/v1/repos/osf/interop/contents/add-ons/guidelines +#additional_capability_urls = https://opendev.org/api/v1/repos/openinfra/interop/contents/add-ons/guidelines # This is the base URL that is used for retrieving specific capability # files. Capability file names will be appended to this URL to get the # contents of that file. (string value) -#opendev_raw_base_url = https://opendev.org/api/v1/repos/osf/interop/raw/ +#opendev_raw_base_url = https://opendev.org/api/v1/repos/openinfra/interop/raw/ # Enable or disable anonymous uploads. If set to False, all clients # will need to authenticate and sign with a public/private keypair diff --git a/refstack-ui/app/components/guidelines/partials/testListModal.html b/refstack-ui/app/components/guidelines/partials/testListModal.html index 31bc83f8..7fe85717 100644 --- a/refstack-ui/app/components/guidelines/partials/testListModal.html +++ b/refstack-ui/app/components/guidelines/partials/testListModal.html @@ -2,7 +2,7 @@

Test List ({{modal.testListCount}})

-

Use this test list with refstack-client +

Use this test list with refstack-client to run only tests in the {{modal.version}} OpenStack Powered™ guideline from capabilities with the following statuses:

    diff --git a/refstack-ui/app/components/profile/importPubKeyModal.html b/refstack-ui/app/components/profile/importPubKeyModal.html index 204f92a4..5b20a9f7 100644 --- a/refstack-ui/app/components/profile/importPubKeyModal.html +++ b/refstack-ui/app/components/profile/importPubKeyModal.html @@ -1,7 +1,7 @@

    Import Public Key

    Instructions for adding a public key and signature can be found - here. diff --git a/refstack/api/app.py b/refstack/api/app.py index a22a4635..c185461f 100644 --- a/refstack/api/app.py +++ b/refstack/api/app.py @@ -81,20 +81,20 @@ API_OPTS = [ help='Template for test result url.' ), cfg.StrOpt('opendev_api_capabilities_url', - default='https://opendev.org/api/v1/repos/osf/interop/contents/' + default='https://opendev.org/api/v1/repos/openinfra/interop/contents/' 'guidelines', help='The GitHub API URL of the repository and location of the ' 'Interop Working Group capability files. This URL is used ' 'to get a listing of all capability files.' ), cfg.StrOpt('additional_capability_urls', - default='https://opendev.org/api/v1/repos/osf/interop/contents/' + default='https://opendev.org/api/v1/repos/openinfra/interop/contents/' 'add-ons/guidelines', help=('The GitHub API URL of the repository and location of ' 'any additional guideline sources which will need to ' 'be parsed by the refstack API.')), cfg.StrOpt('opendev_raw_base_url', - default='https://opendev.org/api/v1/repos/osf/interop/raw/', + default='https://opendev.org/api/v1/repos/openinfra/interop/raw/', help='This is the base URL that is used for retrieving ' 'specific capability files. Capability file names will ' 'be appended to this URL to get the contents of that file.' diff --git a/specs/newton/implemented/defcore-guideline-api.rst b/specs/newton/implemented/defcore-guideline-api.rst index fab04176..77c45ac6 100755 --- a/specs/newton/implemented/defcore-guideline-api.rst +++ b/specs/newton/implemented/defcore-guideline-api.rst @@ -19,7 +19,7 @@ or addition of flagged tests [3], it is useful for RefStack to provide REST APIs so that users can dynamically retrieve the test lists with the latest updates in the Guideline files as needed. -[1] https://opendev.org/osf/interop/src/branch/master/2016.01/ +[1] https://opendev.org/openinfra/interop/src/branch/master/2016.01/ [2] https://review.opendev.org/290689/ [3] https://review.opendev.org/215263/ @@ -118,7 +118,7 @@ The following REST APIs will be added to RefStack. * JSON schema definition for the response data: See DefCore Guideline JSON schema - https://opendev.org/osf/interop/src/master/doc/source/schema + https://opendev.org/openinfra/interop/src/master/doc/source/schema **List tests** diff --git a/specs/newton/implemented/vendor-registration-api.rst b/specs/newton/implemented/vendor-registration-api.rst index 522f1746..71d519bf 100755 --- a/specs/newton/implemented/vendor-registration-api.rst +++ b/specs/newton/implemented/vendor-registration-api.rst @@ -123,7 +123,7 @@ The following REST APIs will be added to RefStack. **Note:** The values of the "type" filed are a set of pre-defined constants (enum) depicting the type of vendors. The constant definition can be found - in https://opendev.org/osf/refstack/src/master/refstack/api/constants.py . + in https://opendev.org/openinfra/refstack/src/master/refstack/api/constants.py . **Show vendor details** diff --git a/specs/prior/implemented/refstack-org-test-result-json-schema.rst b/specs/prior/implemented/refstack-org-test-result-json-schema.rst index ba800ae7..48743f41 100644 --- a/specs/prior/implemented/refstack-org-test-result-json-schema.rst +++ b/specs/prior/implemented/refstack-org-test-result-json-schema.rst @@ -69,7 +69,7 @@ to the user-facing endpoint. **description:** Receive tempest test result from a remote test runner. This function expects json formated pass results. Update to the api described at: -https://opendev.org/osf/refstack/src/branch/master/specs/prior/implemented/api-v1.md +https://opendev.org/openinfra/refstack/src/branch/master/specs/prior/implemented/api-v1.md **url:** post /v1/results diff --git a/specs/queens/approved/subunit-data-api.rst b/specs/queens/approved/subunit-data-api.rst index e3b1726f..f1dd509b 100644 --- a/specs/queens/approved/subunit-data-api.rst +++ b/specs/queens/approved/subunit-data-api.rst @@ -494,4 +494,4 @@ Documentation Impact References ========== -[1] https://opendev.org/osf/refstack/src/branch/master/specs/pike/approved/upload-subunit-tests.rst +[1] https://opendev.org/openinfra/refstack/src/branch/master/specs/pike/approved/upload-subunit-tests.rst diff --git a/tools/update-rs-db.rst b/tools/update-rs-db.rst index 1900100d..1eae3148 100644 --- a/tools/update-rs-db.rst +++ b/tools/update-rs-db.rst @@ -11,7 +11,7 @@ http://example.com:8000/v1 --tokenfile ". In order to successfully update and verify results, you will need admin rights for the refstack server in question. Instructions on how to get these for your local install can be found at -https://opendev.org/osf/refstack/src/master/doc/source/refstack.rst#optional-configure-foundation-organization-and-group +https://opendev.org/openinfra/refstack/src/master/doc/source/refstack.rst#optional-configure-foundation-organization-and-group This script updates RefStack tests as verified given a specific spreadsheet. The columns in this spreadsheet are, in this order: