Thanks for the first review - let's have a quick discussion on Monday whether the information fits in here, or whether we want to create new repo for the "Launchpad project" documentation.
Diff comments: > diff --git a/doc/guides/how-to-qa-turnip-api-changes.rst > b/doc/guides/how-to-qa-turnip-api-changes.rst > new file mode 100644 > index 0000000..9150afa > --- /dev/null > +++ b/doc/guides/how-to-qa-turnip-api-changes.rst > @@ -0,0 +1,94 @@ > +============================ > +How-to qa turnip API changes > +============================ > + > +qa is usually performed on https://qastaging.launchpad.net. > + > +Prerequisites > +============= > + > +- You need access to ``launchpad-bastion-ps5.internal`` > + > +- Your user needs to be able to sudo into ``stg-launchpad-git`` > + > +- You need to have ``lp-shell`` installed in your development environment > + > +Access to above host and the sudo permission are granted by > +`IS <https://portal.admin.canonical.com/new/>`_. > + > +``lp-shell`` can be installed via > + > +.. code-block:: bash > + > + sudo apt install lp-shell Good catch! > + > +Perform qa > +========== > + > +- Pick a project on https://qastaging.launchpad.net, e.g. > + https://qastaging.launchpad.net/turnip > + > +- From above project, pick one git repository, and get its ``repo id`` via > + > + .. code-block:: bash > + > + $ lp-shell qastaging devel > + > + >>> > lp.git_repositories.getByPath(path='~canonical-launchpad-branches/turnip/+git/turnip').id > + 3683 > + > + This id will be used for building the query, > + e.g. for querying the commit API (``/repo/<id>/commits>``). > + > +- Turn on company VPN > + > +- Log into the bastion host > + > + .. code-block:: bash > + > + $ ssh launchpad-bastion-ps5.internal > + > +- Switch to the service user > + > + .. code-block:: bash > + > + ubuntu@juju-a7beac-stg-launchpad-git-7:~$ sudo -iu stg-launchpad-git Yep, you mentioned that combined command in Mattermost. I'd like to keep it separate - if you don't mind. > + > +- Get an overview of the available staging servers via Juju > + > + .. code-block:: bash > + > + $ stg-launchpad-git@launchpad-bastion-ps5:~$ juju status > + > + ... > + > + turnip-api ... > + turnip-celery ... > + turnip-pack... > + > +- Log into one of the API servers > + > + .. code-block:: bash > + > + stg-launchpad-git@launchpad-bastion-ps5:~$ juju ssh turnip-api/0 > + > +- Perform the query > + > + .. code-block:: bash > + > + $ curl \ > + -H "Content-Type: application/json" \ > + -d '{"commits": ["180ad564a7297ee61fbdfe70fdf53d95febd1e09"], > "filter_paths": ["config.yaml"]}' \ > + http://0.0.0.0:19417/repo/3683/commits > + > + $ <results> > + > +- <optional> You can inspect the turnip logs in ``/srv/turnip/logs/``. > + > +Further steps > +============= > + > +Once the changes are verified, > +you can mark the corresponding commit on > https://deployable.ols.canonical.com/project/turnip as deployable. > + > +And finally, the changes `can be deployed > <https://wiki.canonical.com/InformationInfrastructure/WebOps/LP/LaunchpadGitDeployment#Code_upgrade>`_! -- https://code.launchpad.net/~jugmac00/launchpad/+git/launchpad/+merge/414463 Your team Launchpad code reviewers is requested to review the proposed merge of ~jugmac00/launchpad:add-how-to-qa-turnip-api-changes into launchpad:master. _______________________________________________ Mailing list: https://launchpad.net/~launchpad-reviewers Post to : [email protected] Unsubscribe : https://launchpad.net/~launchpad-reviewers More help : https://help.launchpad.net/ListHelp
