Skip to content

Commit

Permalink
Add explicit syntax language to code blocks
Browse files Browse the repository at this point in the history
m2r converts code blocks into ReST code blocks with syntax highlighting.
Auto-detection of the language does not work correctly, though.
Explicitly set the language for console, ini, and Python blocks.

Signed-off-by: Christian Heimes <cheimes@redhat.com>
Reviewed-by: Alexander Bokovoy <abokovoy@redhat.com>
  • Loading branch information
tiran authored and abbra committed Mar 21, 2020
1 parent a9a225d commit 9f2553c
Show file tree
Hide file tree
Showing 5 changed files with 25 additions and 25 deletions.
4 changes: 2 additions & 2 deletions doc/designs/adtrust/samba-domain-controller.md
Original file line number Diff line number Diff line change
Expand Up @@ -173,7 +173,7 @@ As result of it, SMB attributes are not available at `ipa user-add` or
`ipa stageuser-add` level. Instead, it is possible to modify a user object with
`ipa user-mod` or `ipa stageuser-mod` commands:

```
```console
$ ipa user-mod --help
Usage: ipa [global-options] user-mod LOGIN [options]

Expand Down Expand Up @@ -216,7 +216,7 @@ By default, POSIX attribute can only be searched by LDAP clients in
Since SMB service belongs to `cn=services,cn=accounts,$basedn` subtree, new ACI
has to be added.

```
```python
'System: Read POSIX details of the SMB services': {
'replaces_global_anonymous_aci': True,
'ipapermbindruletype': 'all',
Expand Down
30 changes: 15 additions & 15 deletions doc/designs/adtrust/samba-domain-member.md
Original file line number Diff line number Diff line change
Expand Up @@ -142,14 +142,14 @@ Next steps should be performed on the client itself. With the support for Samba
domain member enabled, IPA masters allow creation of the required records with
the host credentials (`host/${hostname}`).

```
```console
# kinit -k
```

1. Retrieve information about Security Identifier and NetBIOS name of the IPA
domain:

```
```console
# kinit -k
# ipa trustconfig-show --raw
cn: ipa.realm
Expand All @@ -168,14 +168,14 @@ the host credentials (`host/${hostname}`).
: IPA domain's SID (security identifier)

`ipaflatname`
: IPA domain's NetBIOS name, `${netbios_name}, also known as the flat name in Active Directory
: IPA domain's NetBIOS name, `${netbios_name}`, also known as the flat name in Active Directory

`ipantdomainguid`
: IPA domain's globally unique identifier (GUID)

2. Retrieve ID range information for the IPA domain and other trusted domains:

```
```console
# ipa idrange-find --raw
----------------
2 ranges matched
Expand Down Expand Up @@ -203,7 +203,7 @@ the host credentials (`host/${hostname}`).
set for specific domains. For each such range, a pair of (range start, range
end) values will need to be calculated:

```
```ini
${range_id_min} = ipabaseid
${range_id_max} = ipabaseid + ipaidrangesize - 1
```
Expand All @@ -216,7 +216,7 @@ the host credentials (`host/${hostname}`).
a sequence of `ipa service-add` and `ipa service-mod` commands cannot be used
instead.

```
```console
# ipa service-add-smb <hostname> [<NetBIOS name>]
```

Expand All @@ -232,7 +232,7 @@ the host credentials (`host/${hostname}`).
enough for a machine account password. The code used by the
`ipa-client-samba` utility is equivalent for the following call:

```
```console
# python3 -c 'import samba; print(samba.generate_random_password(128, 255))'
```

Expand All @@ -244,7 +244,7 @@ the host credentials (`host/${hostname}`).
to [MS-NRPC] section 3.1.4.3.1. The code used by the `ipa-client-samba`
utility is equivalent for the following call:

```
```console
# ipa-getkeytab -p cifs/<hostname> -k /etc/samba/samba.keytab -P \
-e aes128-cts-hmac-sha1-96,aes256-cts-hmac-sha1-96,arcfour-hmac
```
Expand All @@ -260,7 +260,7 @@ the host credentials (`host/${hostname}`).

6. Create Samba config as `/etc/samba/smb.conf` on the client:

```
```ini
[global]
# Limit number of forked processes to avoid SMBLoris attack
max smbd processes = 1000
Expand Down Expand Up @@ -309,7 +309,7 @@ the host credentials (`host/${hostname}`).
that the POSIX path specified in the share actually allows write access to
the users or groups from the `write list`:

```
```ini
[shared]
path = /srv/shared
read only = No
Expand All @@ -327,15 +327,15 @@ the host credentials (`host/${hostname}`).
`smb.conf`. Instead, it is stored in the binary databases managed by Samba.
It can be set through `net setdomainsid` command:

```
```console
# net setdomainsid ${ipantsecurityidentifier}
```

9. For SMB protocol, `BUILTIN\Guests` group has always to be mapped to a local
POSIX groups. It is typically mapped to a local nobody group. This is
required in all recent Samba releases:

```
```console
# net groupmap add sid=S-1-5-32-546 unixgroup=nobody type=builtin
```

Expand All @@ -351,7 +351,7 @@ the host credentials (`host/${hostname}`).
procedure has to be used. The procedure employs low-level tools to
manipulate Samba TDB databases:

```
```console
# tdbtool /var/lib/samba/private/secrets.tdb store SECRETS/MACHINE_LAST_CHANGE_TIME/${netbios_name} '2\00'
# tdbtool /var/lib/samba/private/secrets.tdb store SECRETS/MACHINE_PASSWORD/${netbios_name} '2\00'
# net changesecretpw -f
Expand All @@ -366,7 +366,7 @@ the host credentials (`host/${hostname}`).
all fallback code for the cases when `winbindd` was not running in some
configurations was removed from `smbd` daemon in newer Samba releases.

```
```console
# systemctl start smb winbind
```

Expand All @@ -378,7 +378,7 @@ started, one can access a Samba share as a user from IPA domain. Below is an
example from the test run of `ipatests/test_integration/test_smb.py` done by PR
CI.

```
```console
# kinit athena
Password for athena@IPA.TEST:
# mkdir -p /mnt/athena
Expand Down
2 changes: 1 addition & 1 deletion doc/designs/hidden-replicas.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ replica. First the services must be moved to another replica with
The ``ipa config-show`` command now shows additional information about
DNS and KRA as well as hidden servers:

```
```console
$ ipa config-show
...
IPA masters: server1.ipa.example
Expand Down
2 changes: 1 addition & 1 deletion doc/designs/krb-ticket-policy.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ the mechanisms associated with those auth indicators to obtain a ticket.
By defining a white list of authentication indicators to a service, we can allow a user to use the service
only if the user obtained a ticket with at least one of those indicators included.

#### Note
### Note

For unattended services (services that is a part of the IPA core system), the authentication indicator should not be set,
or it may break the whole system. Examples for such services are `HTTP/*` (for webUI and IPA API end-points),
Expand Down
12 changes: 6 additions & 6 deletions doc/designs/membermanager.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ and writable by everybody with ``System: Modify Groups`` /

Add example user and groups:

```
```console
$ kinit admin
$ ipa user-add john --first John --last Doe --random
$ ipa user-add tom --first Tom --last Doe --random
Expand All @@ -62,14 +62,14 @@ $ ipa group-add project_admins

Make user and group member managers:

```
```console
$ ipa group-add-member-manager project --users=john
$ ipa group-add-member-manager project --groups=project_admins
```

Show group:

```
```console
$ ipa group-show project
Group name: project
GID: 787600003
Expand All @@ -79,7 +79,7 @@ $ ipa group-show project

Find groups by member managers:

```
```console
$ ipa group-find --membermanager-users=john
---------------
1 group matched
Expand All @@ -102,7 +102,7 @@ Number of entries returned 1

Use member management capability:

```
```console
$ kinit john
$ ipa group-add-member project --users=tom
Group name: project
Expand All @@ -117,7 +117,7 @@ Number of members added 1

Remove member management capability:

```
```console
$ kinit admin
$ ipa group-remove-member-manager project --groups=project_admins
Group name: project
Expand Down

0 comments on commit 9f2553c

Please sign in to comment.