Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Simplify installation of DAPS #581

Draft
wants to merge 3 commits into
base: main
Choose a base branch
from
Draft

Conversation

tomschr
Copy link
Collaborator

@tomschr tomschr commented Jan 14, 2021

Our DAPS User guide contains a section "Installing DAPS on openSUSE". It contains 6(!) steps to install daps.

Although the steps are correct, there is an easier way to do. Instead of following all these six steps I was able to reduce it to three. It's enough to pass the correct obs:// URI into zypper addrepo and zypper does the rest (finding also the correct architecture etc.)

We do not need these awkward steps with opening a browser etc. It's
enough to pass the correct obs:// URI into "zypper addrepo" and
zypper does the rest (finding also the correct architecture etc.)
Copy link

@ghost ghost left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Generally looks an alot simpler, typo noted.

doc/xml/phrases-decl.ent Outdated Show resolved Hide resolved
tomschr and others added 2 commits January 16, 2021 13:40
Co-authored-by: Stefan Knorr <sknorr@suse.de>
@tomschr
Copy link
Collaborator Author

tomschr commented Jan 16, 2021

Thanks @sknorr for the feedback! Let me know if I should merge it after your approval.

Another question: I've tried to adhere to the procedure structure. However, I'm wondering if we should maybe go a step further and completely avoid the procedure. I have something like this in mind:

<para>
 The quickest way to install &dapsacr; is using the <command>zypper</command> command.
 Open a terminal and enter the following two commands:
</para>
<screen>&prompt.root;<command>zypper addrepo --refresh obs://&suse-dapsrepo; &suse-dapsrepo;</command>
&prompt.root;<command>zypper install --from &suse-dapsrepo; daps</command></screen>

That way we avoid the (bulky?) procedure, but it would contain all the essential parts. I'm not sure if a procedure is here really needed.

Thoughts?

@fsundermeyer
Copy link
Member

Please note that the obs:// thingie is an unsupported hack according to Adrian.

@tomschr
Copy link
Collaborator Author

tomschr commented Jan 18, 2021

Please note that the obs:// thingie is an unsupported hack according to Adrian.

Whaaat? Oh no! 😞 This is so convenient and short. Hope they fully support it someday.

@adrianschroeter Is there a simpler way to do it?

@adrianschroeter
Copy link
Member

To be a bit more exact, obs:://$project lacks the information which OBS instance actually is intendended.

Inside of an obs this syntax is okay, but everything which goes out (eg. the DISTURL) is using obs://$obsname/$project/... eg. obs://build.opensuse.org/openSUSE:Factory/.. .

What zypper does is their decision, but it can not work atm with any other instance then the build.opensuse.org one. For everyone else (eg. SLE) it is broken.

@tomschr
Copy link
Collaborator Author

tomschr commented Jan 18, 2021

@adrianschroeter Thanks Adrian for your explanation! 👍 Much appreciated. This is not what I have anticipated, but well... 🙂

Currently, we have six steps to install daps. The steps are not really difficult, but cumbersome and error-prone:

Procedure to install daps
  1. Open a browser and enter the following URL: http://download.opensuse.org/repositories/Documentation:/Tools

  2. Select your distribution and product number to make the browser show the URL for the respective repository.

  3. Copy the URL from the address bar.

  4. Open a terminal.

  5. Add the repository with the following zypper command:

    zypper ar -f URL Documentation:Tools
    
  6. Replace URL with the URL you pasted from your browser.

  7. Install DAPS with the following zypper command:

    zypper in --from Documentation:Tools daps
    
  8. In order to install DAPS you have to trust the Documentation:Tools repository.

Imagine how much easier it would be if we could just tell our readers to execute just one or two steps (in contrast to the six steps above).

Maybe I missed it, but I haven't seen any simpler methods. Is there a chance to bless an (improved) obs URL scheme and support it officially in the future? If not, anything else?

@tomschr
Copy link
Collaborator Author

tomschr commented Jan 20, 2021

After studying the manpage, it's also possible to use placeholders in URL. The above procedure could still be reduced to three steps, but with https:// instead of obs:// and the placeholder $releasever:

  1. Open a terminal.

  2. Add the Documentation:Tools repository with the following zypper command:

    # zypper addrepo --refresh "https://download.opensuse.org/repositories/Documentation:/Tools/openSUSE_Leap_\$releasever" doc_tools
    
  3. Install DAPS with the following zypper command:

    # zypper install --from doc_tools daps
    

@fsundermeyer
Copy link
Member

Sorry to rain on your parade again, but this does not work with Tumbleweed. Also, it will not work for SLE.

I think we need to come up with a technical solution for this problem rather than with a simple doc change. Is it possible to automatically generate a YMP file?

@ghost
Copy link

ghost commented Jan 26, 2021

A YMP file can include sections for multiple distributions at once. So we could just provide such a file (e.g. on the DAPS web site) and keep it up-to-date.

@tomschr
Copy link
Collaborator Author

tomschr commented Jan 26, 2021

Well, ... that's all nice, however, IMHO we should address this at a higher level.

Zypper already provide a mechanism via the obs:// scheme. It's even mentioned in the manpage. So we could expect that this is officially supported. If this does not work for Tumbleweed or SLE, it's as bug or at least a useability issue.

For the time being we need to circumvent that somehow, but I'd suggest to address this issue in zypper (via Bugzilla).

@tomschr
Copy link
Collaborator Author

tomschr commented Feb 4, 2021

I've created bsc#1181802.

@tomschr
Copy link
Collaborator Author

tomschr commented Feb 9, 2021

@fsundermeyer

Sorry to rain on your parade again, but this does not work with Tumbleweed.

It is possible. Michael Andres gave me some helpful tips in the mentioned bug report. You need to modify just one file for Tumbleweed:

  1. Open the file /etc/zypp/zypper.conf and locate the [obs] section. Add this line:

    [obs]
    # ...
    platform = openSUSE_Tumbleweed
  2. Add the repository as mentioned:

    $ zypper addrepo obs://Documentation:Tools doc_tools
    
  3. Install whatever you need from this repo.

Also, it will not work for SLE.

It is also possible for SLE. You need to modify the file /etc/zypp/zypper.conf and add the baseUrl option, probably together with platform.

@fsundermeyer fsundermeyer marked this pull request as draft March 11, 2021 14:47
@fsundermeyer
Copy link
Member

Waiting for https://jira.suse.com/browse/PM-2464 to be resolved

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants