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.

Sign up for GitHub

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

Jump to bottom

Update Icinga DB related docs #9387

Merged
merged 13 commits into from
Jun 29, 2022
Merged

Update Icinga DB related docs #9387

merged 13 commits into from
Jun 29, 2022

Conversation

lippserd
Copy link
Member

@lippserd lippserd commented Jun 7, 2022 •
edited
Loading

This PR introduces the following changes:

  • The API section is promoted as almost every Icinga 2 setup requires the API
  • Updated Icinga DB and Icinga DB Redis related instructions
  • Deprecates the IDO
  • Moves unnecessary steps/information from the installation chapter

@cla-bot cla-bot bot added the cla/signed label Jun 7, 2022
@yhabteab
Copy link
Member

yhabteab commented Jun 8, 2022

Ubuntu installation section

Bildschirmfoto 2022-06-08 um 13 35 32

@lippserd
Copy link
Member Author

lippserd commented Jun 8, 2022

Ubuntu installation section

Bildschirmfoto 2022-06-08 um 13 35 32

I don’t think that’s still an issue. Please rebuild the docs.

@julianbrost julianbrost added this to the 2.14.0 milestone Jun 10, 2022
julianbrost
julianbrost reviewed Jun 10, 2022
View reviewed changes
doc/02-installation.md Outdated Show resolved Hide resolved
doc/09-object-types.md Show resolved Hide resolved
doc/02-installation.md Show resolved Hide resolved
doc/09-object-types.md Outdated Show resolved Hide resolved
doc/09-object-types.md Outdated Show resolved Hide resolved
doc/02-installation.md Show resolved Hide resolved
@julianbrost julianbrost added the area/documentation End-user or developer help label Jun 15, 2022
@julianbrost julianbrost mentioned this pull request Jun 15, 2022
Merged
4 tasks
@julianbrost
Copy link
Contributor

Docs should also include something about the /var/lib/icinga2/icingadb.env file as it should be copied when setting up a second node at a later time (either converting a single-node setup to an HA setup or reinstalling a node in an HA setup).

@lippserd lippserd force-pushed the icingadb-docs branch 3 times, most recently from 3b06d36 to b88dba9 Compare June 21, 2022 14:30
@lippserd
Copy link
Member Author

Since the doc branches are not merged yet, you need to manually use https://icinga.com/docs/icinga-db/example-config-and-docs/ for the Icinga DB doc links at the moment.

@lippserd lippserd marked this pull request as ready for review June 22, 2022 11:39
@lippserd lippserd requested a review from julianbrost June 22, 2022 11:39
julianbrost
julianbrost reviewed Jun 29, 2022
View reviewed changes
doc/09-object-types.md Show resolved Hide resolved
doc/14-features.md Show resolved Hide resolved
doc/02-installation.md Show resolved Hide resolved
doc/02-installation.md Outdated Show resolved Hide resolved
lippserd added 13 commits June 29, 2022 14:48
@lippserd
Docs: Move API install instructions up
ebda4ff 
Almost every Icinga 2 node setup requires the Icinga 2 API, as Icinga
Web connects to it, Icinga DB requires it, and although it's not clearly
mentioned anywhere in the documentation at the moment, it enables the
cluster communication functionality.
@lippserd
Docs: Update API install instructions
f369f86
@lippserd
Docs: Promote and update Icinga DB related install instructions
bd618c4
@lippserd
Docs: Deprecate IDO
f982127
@lippserd
Docs: Move IDO setup to its feature section
cb04995
@lippserd
Docs: Remove installation overview
c478f1b 
That's useless.
@lippserd
Docs: Remove addons section from installation chapter
c8fe060 
There is a separate chapter, so why draw attention to installing even
more things.
@lippserd
Docs: Move syntax highlighting section to addons chapter
9d64b47
@lippserd
Docs: Update Icinga DB feature section
9523e58
@lippserd
Docs: Update Icinga DB oject type section
148c487
@lippserd
Docs: Add install Icinga DB daemon section
498079b
@lippserd
Docs: Remove install Icinga Web section
e2e9747 
The Icinga DB docs will link to installing Icinga DB Web.
@lippserd
Docs: Remove instructions for CentOS 8
783387d
julianbrost
julianbrost reviewed Jun 29, 2022
View reviewed changes
Copy link
Contributor

@julianbrost julianbrost left a comment

Choose a reason for hiding this comment

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

Fine in general now, just that one comment remaining that got no reaction as far as I can see.

doc/02-installation.md Show resolved Hide resolved
@julianbrost julianbrost merged commit 73d3323 into master Jun 29, 2022
@julianbrost julianbrost added the consider backporting Should be considered for inclusion in a bugfix release label Jun 29, 2022
@icinga-probot icinga-probot bot deleted the icingadb-docs branch June 29, 2022 13:43
@julianbrost julianbrost mentioned this pull request Jun 29, 2022
Merged
@julianbrost julianbrost added backported Fix was included in a bugfix release and removed consider backporting Should be considered for inclusion in a bugfix release labels Jul 20, 2022
@julianbrost julianbrost mentioned this pull request Jul 25, 2022
Closed
yhabteab pushed a commit that referenced this pull request Sep 5, 2022
@julianbrost @yhabteab
Merge pull request #9387 from Icinga/icingadb-docs
7f59d03 
Update Icinga DB related docs
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@julianbrost julianbrost julianbrost approved these changes

Assignees
No one assigned
Labels
area/documentation End-user or developer help backported Fix was included in a bugfix release cla/signed
Projects
None yet
Milestone
2.14.0
Development

Successfully merging this pull request may close these issues.
3 participants
@lippserd @yhabteab @julianbrost