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

Documentation for general installation in containerized environments #3355

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

me-coder
Copy link
Contributor

@me-coder me-coder commented Oct 2, 2024

The CFEngine installation guide is missing out on containers.
This PR is an attempt to project the capability of CFEngine with containers (using ubi9-init images).

There are a few limitations due to the nature of CFEngine (requires privileged mode and container is required to have systemd, which need initialization with /var/sbin/init).
However, it still gives a good ability to test CFEngine in containerized environments in full capacity, without the need to have a bulky multi VM setup.

Hope the moderator team finds this useful and decides to integrate it into the docs.

@me-coder me-coder force-pushed the master branch 5 times, most recently from fa645e7 to 5e7da00 Compare October 2, 2024 19:18
@me-coder
Copy link
Contributor Author

me-coder commented Oct 2, 2024

I am unable to figure out the reason for failure of check with:
Run markdowner.py on all markdown files and see if there are changes / check (pull_request)

Any help to deal with this cryptic error is appreciated.

@olehermanse
Copy link
Member

I am unable to figure out the reason for failure of check with:
Run markdowner.py on all markdown files and see if there are changes / check (pull_request)

Any help to deal with this cryptic error is appreciated.

Your files have extra spaces in them, at the ends of multiple lines.
Change your editor to automatically trim trailing whitespace for you, or run the command as suggested;

python3 .github/workflows/markdowner.py ./getting-started/installation/general-installation/installation-community-containerized.markdown

That will edit the file, removing those extra unnecessary spaces.
(Afterwards you will need to add and commit those changes - git add -p ; git commit).

@me-coder
Copy link
Contributor Author

me-coder commented Oct 3, 2024

I am unable to figure out the reason for failure of check with:
Run markdowner.py on all markdown files and see if there are changes / check (pull_request)

Any help to deal with this cryptic error is appreciated.

Your files have extra spaces in them, at the ends of multiple lines. Change your editor to automatically trim trailing whitespace for you, or run the command as suggested;

python3 .github/workflows/markdowner.py ./getting-started/installation/general-installation/installation-community-containerized.markdown

That will edit the file, removing those extra unnecessary spaces. (Afterwards you will need to add and commit those changes - git add -p ; git commit).

The extra spaces (particularly ^.+<space><space>$ was required for newline as per the markdown requirements.
However, that has been replaced by </br> now and seems to have worked.
Thanks for the suggestion.

@me-coder
Copy link
Contributor Author

me-coder commented Oct 3, 2024

@olehermanse,
I've made this change to take care of such situations, if encountered by other contributors:
c9719c9

Hope that's fine.

@olehermanse
Copy link
Member

The extra spaces (particularly ^.+$ was required for newline as per the markdown requirements.

What requirements? This is not required.

However, that has been replaced by
now and seems to have worked.

No, remove these, they are not necessary.

I've made this change to take care of such situations, if encountered by other contributors:
c9719c9

Hope that's fine.

No, that change is not correct, remove it. We want to strip trailing whitespace. You don't need trailing whitespace nor html tags (</br>) to write this tutorial.

Copy link
Member

@nickanderson nickanderson left a comment

Choose a reason for hiding this comment

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

@me-coder thank you for this contribution. Overall it's quite a nice addition. Looking forward to having this in the docs.

@@ -2,7 +2,7 @@
layout: default
title: Installing Enterprise on CoreOS
Copy link
Member

Choose a reason for hiding this comment

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

@olehermanse Perhaps this should be re-titled to Installing Enterprise using disk image Or actually, maybe we need to drop this page completely. I don't see that we are still publishing a disk image since CoreOS is died (and now it's resurrected under Fedora https://fedoraproject.org/coreos/ ).

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@nickanderson, it seems GitHub expects this review comment to be resolved for the review to be marked complete.
The link against requested change #3355 (review) which doesn't seem like the issue.

Can this be reconsidered?

Copy link
Member

Choose a reason for hiding this comment

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

Hi @me-coder I don't think it's because of this comment, just the other comments and suggestions in general where my review was set for requested changes.

Anyway, this comment had nothing to do with your PR. I just need to re-review.

@me-coder
Copy link
Contributor Author

me-coder commented Oct 4, 2024

Hi @olehermanse, @nickanderson,
Thank you for the detailed review.

I made the suggested changes and also a few enhancements to the document and force pushed it as a amended single commit.
I'm not sure if the suggested commits were supposed to be incorporated or were just markers for the review suggestions. (unaware of the rules being followed for this project).

I submitted a single commit as I always feel it's cleaner, could be fast-forwarded and there were changes which I could easily edit as a batch in VSCode editor.

Kindly re-consider the review with the applied changes.

- @me-coder

@nickanderson nickanderson dismissed their stale review October 10, 2024 04:28

Changes have been made, and re-review is needed.

@nickanderson
Copy link
Member

I am traveling and I likely won't get around to looking at this again until next week at the very earliest if I manage to catch up with other things after travel.

@me-coder
Copy link
Contributor Author

Hi @nickanderson , @olehermanse, @craigcomstock,
Could you revisit the review?

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

Successfully merging this pull request may close these issues.

3 participants