Skip to content

Commit

Permalink
Apply suggestions from code review
Browse files Browse the repository at this point in the history 
Co-authored-by: Malte Sander <[email protected]>
  • Loading branch information
@sbernauer @maltesander
sbernauer and maltesander authored Jan 17, 2024
1 parent d6986d2 commit c635838
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions docs/modules/hbase/pages/usage-guide/security.adoc
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ The xref:home:secret-operator:secretclass.adoc#backend-kerberoskeytab[secret-ope

=== 1. Prepare Kerberos server
To configure HDFS to use Kerberos you first need to collect information about your Kerberos server, e.g. hostname and port.
Additionally you need a service-user, which the secret-operator uses to create create principals for the HDFS services.
Additionally, you need a service-user which the secret-operator uses to create principals for the HDFS services.

=== 2. Create Kerberos SecretClass

Check notice on line 12 in docs/modules/hbase/pages/usage-guide/security.adoc

View workflow job for this annotation

GitHub Actions / LanguageTool

[LanguageTool] docs/modules/hbase/pages/usage-guide/security.adoc#L12 

In American English, ‘afterward’ is the preferred variant. ‘Afterwards’ is more commonly used in British English and other dialects. (AFTERWARDS_US[1])
Suggestions: `Afterward`
Rule: https://community.languagetool.org/rule/show/AFTERWARDS_US?lang=en-US&subId=1
Category: BRITISH_ENGLISH
Raw output 
docs/modules/hbase/pages/usage-guide/security.adoc:12:35: In American English, ‘afterward’ is the preferred variant. ‘Afterwards’ is more commonly used in British English and other dialects. (AFTERWARDS_US[1])
 Suggestions: `Afterward`
 Rule: https://community.languagetool.org/rule/show/AFTERWARDS_US?lang=en-US&subId=1
 Category: BRITISH_ENGLISH
Afterwards you need to enter all the needed information into a SecretClass, as described in xref:home:secret-operator:secretclass.adoc#backend-kerberoskeytab[secret-operator documentation].
Expand Down Expand Up @@ -37,7 +37,7 @@ The `kerberos.secretClass` is used to give HBase the possibility to request keyt

The `tlsSecretClass` is needed to request TLS certificates, used e.g. for the Web UIs.

=== 4. Verify that Kerberos authentication is required
=== 5. Verify that Kerberos authentication is required
Shell into the `hbase-master-default-0` Pod and execute the following commands:

1. `kdestroy` (just in case you run `kinit` in the Pod already in the past)
Expand All @@ -46,7 +46,7 @@ Shell into the `hbase-master-default-0` Pod and execute the following commands:
The last command should fail with the error message `ERROR: Found no valid authentication method from options`.
You can also check the RestServer by calling `curl -v --insecure https://hbase-restserver-default:8081`, which should return `HTTP ERROR 401 Authentication required`.

=== 5. Access HBase
=== 6. Access HBase
In case you want to access your HBase it is recommended to start up a client Pod that connects to HBase, rather than shelling into the master.
We have an https://github.com/stackabletech/hbase-operator/blob/main/tests/templates/kuttl/kerberos/41-access-hbase.j2[integration test] for this exact purpose, where you can see how to connect and get a valid keytab.

Check notice on line 51 in docs/modules/hbase/pages/usage-guide/security.adoc

View workflow job for this annotation

GitHub Actions / LanguageTool

[LanguageTool] docs/modules/hbase/pages/usage-guide/security.adoc#L51 

Use “a” instead of ‘an’ if the following word doesn’t start with a vowel sound, e.g. ‘a sentence’, ‘a university’. (EN_A_VS_AN)
Suggestions: `a`
URL: https://languagetool.org/insights/post/indefinite-articles/ 
Rule: https://community.languagetool.org/rule/show/EN_A_VS_AN?lang=en-US
Category: MISC
Raw output 
docs/modules/hbase/pages/usage-guide/security.adoc:51:8: Use “a” instead of ‘an’ if the following word doesn’t start with a vowel sound, e.g. ‘a sentence’, ‘a university’. (EN_A_VS_AN)
 Suggestions: `a`
 URL: https://languagetool.org/insights/post/indefinite-articles/ 
 Rule: https://community.languagetool.org/rule/show/EN_A_VS_AN?lang=en-US
 Category: MISC

Expand Down

0 comments on commit c635838

Please sign in to comment.