Skip to content

Add initial organization and location values for foremanctl#4789

Open
jafiala wants to merge 2 commits intotheforeman:masterfrom
jafiala:Add-initial-org-and-loc-foremanctl-SAT-44441
Open

Add initial organization and location values for foremanctl#4789
jafiala wants to merge 2 commits intotheforeman:masterfrom
jafiala:Add-initial-org-and-loc-foremanctl-SAT-44441

Conversation

@jafiala
Copy link
Copy Markdown
Contributor

@jafiala jafiala commented Apr 24, 2026 •
edited by maximiliankolb
Loading

What changes are you introducing?

Add the --inital-organization and --initial-location parameters to foremanctl docs, including the note about not being able to change the label.

Why are you introducing these changes? (Explanation, links to references, issues, etc.)

https://redhat.atlassian.net/browse/SAT-44441

Anything else to add? (Considerations, potential downsides, alternative solutions you have explored, etc.)

Also split the abstracts to comply with the CQA rule of max. 2 sentences per abstract.

Contributor checklists

  • I am okay with my commits getting squashed when you merge this PR.
  • I am familiar with the contributing guidelines.

Please cherry-pick my commits into:

  • Foreman 3.18/Katello 4.20 (Satellite 6.19)
  • Foreman 3.17/Katello 4.19
  • Foreman 3.16/Katello 4.18 (Satellite 6.18; orcharhino 7.6 and 7.7)
  • Foreman 3.15/Katello 4.17
  • Foreman 3.14/Katello 4.16 (Satellite 6.17; orcharhino 7.4; orcharhino 7.5)
  • Foreman 3.13/Katello 4.15 (EL9 only)
  • Foreman 3.12/Katello 4.14 (Satellite 6.16; orcharhino 7.2 on EL9 only; orcharhino 7.3)
  • We do not accept PRs for Foreman older than 3.12.

@github-actions github-actions Bot added Needs tech review Requires a review from the technical perspective Needs style review Requires a review from docs style/grammar perspective Needs testing Requires functional testing labels Apr 24, 2026
@github-actions
Copy link
Copy Markdown

github-actions Bot commented Apr 24, 2026 •
edited
Loading

The PR preview for b022250 is available at theforeman-foreman-documentation-preview-pr-4789.surge.sh

The following output files are affected by this PR:

show diff

show diff as HTML

maximiliankolb
maximiliankolb reviewed Apr 24, 2026
View reviewed changes
Comment thread guides/common/modules/proc_deploy-project-server-configuration-with-an-external-database.adoc Outdated
Comment thread guides/common/modules/proc_deploy-project-server-configuration-with-the-default-database.adoc Outdated
Comment thread guides/common/modules/proc_deploy-project-server-configuration-with-the-default-database.adoc Outdated
@jafiala
Copy link
Copy Markdown
Contributor Author

jafiala commented Apr 24, 2026

Troubleshooting the build error.

maximiliankolb
maximiliankolb reviewed Apr 24, 2026
View reviewed changes
Copy link
Copy Markdown
Contributor

@maximiliankolb maximiliankolb left a comment

Choose a reason for hiding this comment

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

Thanks for aligning it to our current convention. One more small suggestion.

Comment thread guides/common/modules/proc_deploy-project-server-configuration-with-an-external-database.adoc Outdated
arvind4501
arvind4501 approved these changes Apr 24, 2026
View reviewed changes
Copy link
Copy Markdown
Contributor

@arvind4501 arvind4501 left a comment

Choose a reason for hiding this comment

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

LGTM

maximiliankolb
maximiliankolb approved these changes Apr 24, 2026
View reviewed changes
Copy link
Copy Markdown
Contributor

@maximiliankolb maximiliankolb left a comment

Choose a reason for hiding this comment

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

LGTM style-wise.

@maximiliankolb maximiliankolb added style review done No issues from docs style/grammar perspective and removed Needs style review Requires a review from docs style/grammar perspective labels Apr 24, 2026
evgeni
evgeni approved these changes Apr 24, 2026
View reviewed changes
Copy link
Copy Markdown
Member

@evgeni evgeni left a comment

Choose a reason for hiding this comment

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

tech-ack

Comment thread guides/common/modules/proc_deploy-project-server-configuration-with-the-default-database.adoc Outdated
Comment thread guides/common/modules/proc_deploy-project-server-configuration-with-an-external-database.adoc
--pulp-worker-count _My_Pulp_Worker_Count_ \
--foreman-database-name _My_Foreman_Database_Name_ \
--foreman-database-user _My_Foreman_Database_User_ \
--foreman-database-password _My_Foreman_Database_Password_
Copy link
Copy Markdown
Member

@evgeni evgeni Apr 24, 2026

Choose a reason for hiding this comment

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

lots of unrelated capitalization noise here, is that a new linting rule or something you need to adhere to?
(I am here for the tech ack only, so won't block or anything, but finding the --initial-* lines that were added in this diff is hard)

Copy link
Copy Markdown
Contributor

@maximiliankolb maximiliankolb Apr 24, 2026

Choose a reason for hiding this comment

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

We allow multiple commits per PR & can keep the history when merging.

Not a new linting rule per se, but something that we do within foreman-documentation in general. Maybe @jafiala can rebase the PR and split the changes into two clean commits & we'll merge with "rebase" instead of squashing it?

Copy link
Copy Markdown
Member

@evgeni evgeni Apr 24, 2026

Choose a reason for hiding this comment

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

two commits sounds good to me!

Copy link
Copy Markdown
Contributor Author

@jafiala jafiala Apr 24, 2026

Choose a reason for hiding this comment

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

Done, please check.

@maximiliankolb maximiliankolb added tech review done No issues from the technical perspective and removed Needs tech review Requires a review from the technical perspective labels Apr 24, 2026
jafiala and others added 2 commits April 24, 2026 15:06
@jafiala @claude
Improve foremanctl deploy documentation
34916eb 
* Create reusable snippets for repeated notes
* Fix placeholder capitalization for consistency
* Add installer-log-file attribute for foremanctl
* Improve formatting and readability

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
@jafiala @claude
Add initial organization and location parameters
b022250 
Add --initial-organization and --initial-location parameters to
foremanctl deploy command examples with explanatory note about
organization naming and labeling.

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
@jafiala jafiala force-pushed the Add-initial-org-and-loc-foremanctl-SAT-44441 branch from c0cc60e to b022250 Compare April 24, 2026 13:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@evgeni evgeni evgeni approved these changes

@maximiliankolb maximiliankolb maximiliankolb approved these changes

+1 more reviewer

@arvind4501 arvind4501 arvind4501 approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

Needs testing Requires functional testing style review done No issues from docs style/grammar perspective tech review done No issues from the technical perspective

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@jafiala @evgeni @maximiliankolb @arvind4501