Skip to content

Commit 43148ea

Browse files
RendanicRendanic
committed
documentation: some fixes
1 parent 6e0f9c7 commit 43148ea

File tree

4 files changed

+127
-9
lines changed

4 files changed

+127
-9
lines changed

‎changelogs/fragments/299-doc.yml‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
11
---
22
minor_changes:
33
- "Documentation: Added feauturelist and missing picture (#299)"
4+
5+
trivial:
6+
- "beginner.adoc: typo"
7+
- "developer.adoc: more details"
8+
- "advanced.puml: small fix"

‎doc/development.adoc‎

Lines changed: 117 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,69 @@ toc::[]
44
:sectnums:
55
:sectnumlevels: 4
66

7-
= Pull-Requests
7+
== How to develop in `ansible-oracle`?
88

9+
IMPORTANT: This is an example how most of the development in `ansible-oracle` is done. +
10+
A Pull-Request is only accepted, when `github-Actions` are valid.
911

10-
== Important Information
12+
=== Prepare a development environment
13+
14+
IMPORTANT: This chapter shows, how the development envionment could look like. +
15+
You need an Ansible-Controller with an Editor or IDE of your own choice.
16+
17+
18+
19+
=== Create Fork on github and contribute to the project
20+
21+
link:https://docs.github.com/en/get-started/quickstart/contributing-to-projects[github] has a great documentation with details about creating a fork and branch to contribute to `ansible-oracle`.
22+
23+
IMPORTANT: The `github-Actions` will automatically start, when the branchname starts with `pr` or in each Pull-Request. +
24+
Please use a branch with 'pr'--prefix, when `ansible-lint` should be checked for each commit.
25+
26+
=== pre-commit
27+
28+
IMPORTANT: link:https://pre-commit.com/[pre-commit] is a nice tool for git. +
29+
Each commit is locally checked against multiple rules, to prevent failures in github-Actions after pushing commits to github. +
30+
This tool is recommended but not mandatory for contributing to `ansible-oracle`.
31+
32+
.Installation (cd into repository before)
33+
----
34+
pip install --user pre-commit
35+
pre-commit install
36+
----
37+
38+
.run outside git
39+
----
40+
pre-commit run
41+
----
42+
43+
=== Start Ansible-Container
44+
45+
=== Start Playbook
46+
47+
IMPORTANT: Don't forget to set the working branch in `requirements.yml`. +
48+
Remove/Disable `devsec.hardening` for faster installation of Ansible collection, when devsec should not be tested.
49+
50+
51+
.Edit requirements.yml
52+
----
53+
---
54+
collections:
55+
# - name: devsec.hardening
56+
# version: 8.2.0
57+
- name: https://github.com/Rendanic/ansible-oracle.git
58+
type: git
59+
version: devbranch
60+
----
61+
62+
.Execute ansible-playbook
63+
----
64+
ansible-galaxy collection install --force -r requirements.yml && ansible-playbook -i inventory/hasfd -e hostgroup='all' playbooks/single-instance-asm.yml --limit '*19c*'
65+
----
66+
67+
== Pull-Requests
68+
69+
=== Important Information
1170

1271
The ansible-oracle project introduced `antsibull-changelog` for managing the `CHANGELOG.rst` based on fragments in `changelogs/gragments`.
1372

@@ -17,13 +76,67 @@ If multiple PRs are open, the upper rule makes sure that no duplicate files are
1776

1877
IMPORTANT: Each Pull-Requests needs a fragment from Release 3.0.0 onwards!
1978

20-
== Working with antsibull-changelog
79+
<<<<<<< HEAD
80+
== Create new Releases in `ansible-oracle`
81+
82+
IMPORTANT: This is only needed for creating new Releases in `ansible-oracle` - not for development!
83+
84+
85+
=======
86+
== Create new Releases in `ansible-oracle`
87+
88+
IMPORTANT: This is only needed for creating new Releases in `ansible-oracle` - not for development!
89+
90+
>>>>>>> 2226b8a9fe5dec919cdb916059f233c63b914fc9
91+
=== Install antsibull-changelog
92+
93+
----
94+
cd ansible-oracle/docker
95+
docker-compose run --rm -w /git/ansible-oracle/example/beginner/ansible ansible bash
96+
97+
pip3 install antsibull-changelog
98+
----
99+
100+
=== Working with antsibull-changelog
21101
22102
Changelogs for Collections: https://github.com/ansible-community/antsibull-changelog/blob/main/docs/changelogs.rst#releasing-a-new-version-of-a-collection
23103
24-
== Creating new releases
104+
=== Creating new releases
25105
26106
`antsibull-changelog release` reads `galaxy.yml` to get the release version automatically.
27107
The execution is aborted, when a release with the version is existing in `CHANGELOG.rst`.
28108
29109
NOTE: The whole release process should be donw with a dedicated Pull-Request.
110+
111+
----
112+
antsibull-changelog release
113+
----
114+
115+
== Update Vagrantbox on vagrantcloud for examples
116+
117+
IMPORTANT: This is only an example how to do it, when custom images should be used.
118+
119+
=== Create new Box
120+
121+
----
122+
git clone https://github.com/Rendanic/bento.git
123+
cd bento
124+
git checkout oc
125+
cd packer_templates/oraclelinux/
126+
./oc_oracle-7.x_vbox.sh oracle-7.9-x86_64.json
127+
----
128+
129+
=== Upload new Version
130+
131+
IMPORTANT: Change the boxname to an account with write priviledges.
132+
133+
.Upload new version after build:
134+
----
135+
boxname="Rendanic/oraclelinux-7.x"
136+
vagrantversion=$(date +%y%m%d)
137+
138+
vagrant cloud version create ${boxname} "$vagrantversion"
139+
vagrant cloud provider create ${boxname} virtualbox "$vagrantversion"
140+
vagrant cloud provider upload ${boxname} virtualbox "$vagrantversion" ../../builds/oracle-7.9.virtualbox.box
141+
vagrant cloud publish --release ${boxname} "$vagrantversion" virtualbox
142+
----

‎doc/guides/advanced.puml‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -19,10 +19,6 @@ System_Boundary(host, "Host System", "PC/Notebook") {
1919
Container(ssh, "ssh", "ssh vagrant@192.168.56.161", $tags="software")
2020
Container(vagrant, "Vagrant", "", $tags="software")
2121
Container(git, "git", "git clone for Vagrantfile from ansible-oracle", $tags="software")
22-
23-
SetPropertyHeader("Windows Environment Variable","Description")
24-
AddProperty("VAGRANT_ANSIBLE_ORACLE_SW", "Drive with directory on Host System")
25-
Container(instmediahost, "Installation Media", "Environment Variable for vboxsf mount in VM", $tags="media")
2622
}
2723
}
2824
Boundary(virtualbox, "VirtualBox") {
@@ -40,7 +36,11 @@ System_Boundary(host, "Host System", "PC/Notebook") {
4036
Container(instmedia, "Installation Media from Environment Variable VAGRANT_ANSIBLE_ORACLE_SW mounted on /sw/oracle inside VM", "ORA 19c", $tags="media")
4137
}
4238
}
39+
SetPropertyHeader("Windows Environment Variable","Description")
40+
AddProperty("VAGRANT_ANSIBLE_ORACLE_SW", "Drive with directory on Host System")
41+
Container(instmediahost, "Installation Media", "Environment Variable for vboxsf mount in VM", $tags="media")
4342
}
43+
Rel_Up(instmediahost, instmedia, "vboxsf")
4444
Rel_Down(admin, tools, "")
4545
Rel_Down(conemu, vmansible, "ssh with agent forwarding")
4646
Rel_Down(vmansible, dbfs, "ssh with key from Agent")

‎doc/guides/beginner.adoc‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -182,7 +182,7 @@ ansible-playbook -i inventory/ -e hostgroup=dbfs playbooks/single-instance-fs.ym
182182
----
183183

184184
The Database creation has been completed. +
185-
See the follwoing chapter for details about how to work with the VM.
185+
See the following chapter for details about how to work with the VM.
186186

187187

188188
=== How to work with installed database

0 commit comments

Comments
 (0)