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

Improve installation docs and include running Pelican server with docker image #904

Merged
merged 5 commits into from
Mar 15, 2024

Conversation

haoming29
Copy link
Contributor

@haoming29 haoming29 commented Mar 6, 2024

This PR revised Install page of Pelican documentation. It adds a page to explain how to run Pelican servers with Docker images.

Still waiting for example to run cache in docker container, and instructions to run windows binary. Appreciate if anyone knows how to do any of them.

@haoming29 haoming29 added the documentation Improvements or additions to documentation label Mar 6, 2024
@haoming29 haoming29 added this to the v7.6.0 milestone Mar 6, 2024

## Supported Operating Sytems

Pelican supports the following operating systems:
Copy link
Member

Choose a reason for hiding this comment

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

I'd be careful in making this claim. While we can technically run the pelican binary on Windows, most of the functionality is turned of or compiled out. It's not as bad with MacOS, but we're still largely untested there as well.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Do you think is is for windows only or the claim that we support the OS? If it's former, then I can add a note to Windows item suggesting that we only support client functionality. This would be the same thing for macOS where I don't think xrootd works well with mac and people should be required to build xrootd from source

Copy link
Member

Choose a reason for hiding this comment

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

Good question. I haven't even tested the client on Windows and I've not examined the extent of our windows tests. Does the client fully work there?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I've bugged @joereuss12 to run the .exe program we generated and see if that works

docs/pages/install/rhel.mdx Outdated Show resolved Hide resolved
@haoming29
Copy link
Contributor Author

@jhiemstrawisc Are we good with Joe's testing? Any other comments/thoughts?

@jhiemstrawisc
Copy link
Member

I think Joe's testing shows we're okay. We can always come back and change it if a user proves us wrong.

@haoming29
Copy link
Contributor Author

Latest commit is to reflect changes in #945

Copy link
Member

@jhiemstrawisc jhiemstrawisc left a comment

Choose a reason for hiding this comment

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

LGTM. Thanks Haoming!

@haoming29 haoming29 merged commit 879573f into PelicanPlatform:main Mar 15, 2024
16 of 18 checks passed
@haoming29 haoming29 deleted the update-install-doc branch March 15, 2024 20:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants