Skip to content

Commit 6becb4b

Browse files
committed
Terminology updates for builds book
1 parent 83f0e0e commit 6becb4b

File tree

130 files changed

+607
-691
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

130 files changed

+607
-691
lines changed

_topic_map.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -614,6 +614,9 @@ Topics:
614614
- Name: Syncing LDAP groups
615615
File: ldap-syncing
616616
Distros: openshift-enterprise,openshift-webscale,openshift-origin,openshift-dedicated
617+
- Name: Creating and using config maps
618+
File: configmaps
619+
Distros: openshift-enterprise,openshift-webscale,openshift-origin,openshift-dedicated
617620
---
618621
Name: Networking
619622
Dir: networking
@@ -1061,9 +1064,6 @@ Topics:
10611064
- Name: Setting up additional trusted certificate authorities for builds
10621065
File: setting-up-trusted-ca
10631066
Distros: openshift-enterprise,openshift-webscale,openshift-origin,openshift-dedicated
1064-
- Name: Creating and using ConfigMaps
1065-
File: builds-configmaps
1066-
Distros: openshift-enterprise,openshift-webscale,openshift-origin,openshift-dedicated
10671067
---
10681068
Name: Pipelines
10691069
Dir: pipelines

authentication/configmaps.adoc

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
[id="configmaps"]
2+
= Creating and using config maps
3+
include::modules/common-attributes.adoc[]
4+
:context: configmaps
5+
6+
toc::[]
7+
8+
The following sections define config maps and how to create and use them.
9+
10+
include::modules/authentication-configmap-overview.adoc[leveloffset=+1]
11+
12+
include::modules/authentication-configmap-create-from-console.adoc[leveloffset=+1]
13+
14+
include::modules/authentication-configmap-create.adoc[leveloffset=+1]
15+
16+
include::modules/authentication-configmap-creating-from-directories.adoc[leveloffset=+2]
17+
18+
include::modules/authentication-configmap-creating-from-files.adoc[leveloffset=+2]
19+
20+
include::modules/authentication-configmap-creating-from-literal-values.adoc[leveloffset=+2]
21+
22+
[id="authentication-configmaps-consuming-configmap-in-pods"]
23+
== Use Cases: Consuming ConfigMaps in pods
24+
25+
The following sections describe some uses cases when consuming `ConfigMap`
26+
objects in pods.
27+
28+
include::modules/authentication-configmaps-use-case-consuming-in-env-vars.adoc[leveloffset=+2]
29+
30+
include::modules/authentication-configmaps-use-case-setting-command-line-arguments.adoc[leveloffset=+2]
31+
32+
include::modules/authentication-configmaps-use-case-consuming-in-volumes.adoc[leveloffset=+2]

builds/advanced-build-operations.adoc

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,6 @@ The following sections provide instructions for advanced build operations includ
88
setting build resources and maximum duration, assigning builds to nodes, chaining
99
builds, build pruning, and build run policies.
1010

11-
// The following include statements pull in the module files that comprise the assembly. Include any combination of concept, procedure, or reference modules required to cover the user story. You can also include other assemblies.
12-
1311
include::modules/builds-setting-build-resources.adoc[leveloffset=+1]
1412

1513
include::modules/builds-setting-maximum-duration.adoc[leveloffset=+1]

builds/basic-build-operations.adoc

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,7 @@ include::modules/common-attributes.adoc[]
44
:context: basic-build-operations
55
toc::[]
66

7-
The following sections provide instructions for basic build operations including
8-
starting and canceling builds, deleting BuildConfigs, viewing build details, and
9-
accessing build logs.
10-
11-
// The following include statements pull in the module files that comprise the assembly. Include any combination of concept, procedure, or reference modules required to cover the user story. You can also include other assemblies.
7+
The following sections provide instructions for basic build operations including starting and canceling builds, deleting BuildConfigs, viewing build details, and accessing build logs.
128

139
include::modules/builds-basic-start-build.adoc[leveloffset=+1]
1410
include::modules/builds-basic-start-re-run.adoc[leveloffset=+2]

builds/builds-configmaps.adoc

Lines changed: 0 additions & 32 deletions
This file was deleted.

builds/custom-builds-buildah.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@ include::modules/common-attributes.adoc[]
55
toc::[]
66

77

8-
With {product-title} {product-version}, a Docker socket will not be present on the host
8+
With {product-title} {product-version}, a docker socket will not be present on the host
99
nodes. This means the _mount docker socket_ option of a custom build is not
10-
guaranteed to provide an accessible Docker socket for use within a custom build
10+
guaranteed to provide an accessible docker socket for use within a custom build
1111
image.
1212

1313
If you require this capability in order to build and push images, add the Buildah

builds/running-entitled-builds.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,8 @@ include::modules/builds-source-secrets-entitlements.adoc[leveloffset=+1]
1313
There are two paths to pulling in the base RHEL image:
1414

1515
* Add the pull secret to registry.redhat.io to your project.
16-
* Create an imagestream in the `openshift` namespace for the RHEL-based
17-
image. This makes the imagestream available across the cluster.
16+
* Create an image stream in the `openshift` namespace for the RHEL-based
17+
image. This makes the image stream available across the cluster.
1818

1919
== Running builds with Subscription Manager
2020

@@ -33,5 +33,5 @@ include::modules/builds-strategy-docker-squash-layers.adoc[leveloffset=+1]
3333

3434
== Additional resources
3535

36-
* See xref:../openshift_images/image-streams-manage.adoc#image-streams-managing[Managing imagestreams]
36+
* See xref:../openshift_images/image-streams-manage.adoc#image-streams-managing[Managing image streams]
3737
for more information.

builds/securing-builds-by-strategy.adoc

Lines changed: 5 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -4,26 +4,11 @@ include::modules/common-attributes.adoc[]
44
:context: securing-builds-by-strategy
55
toc::[]
66

7-
Builds in {product-title} are run in privileged containers. Depending on the
8-
build strategy used, this allows a user who can run builds to escalate their
9-
permissions on the cluster and host nodes. As a security measure, limit who can
10-
run builds and the strategy that is used for those builds. Custom builds are
11-
inherently less safe than Source builds, because they can execute any code
12-
within a privileged container, and are disabled by default. Grant Docker build
13-
permissions with caution, because a vulnerability in the Dockerfile processing
14-
logic could result in a privileges being granted on the host node.
15-
16-
By default, all users that can create builds are granted permission to use the
17-
Docker and Source-to-Image (S2I) build strategies. Users with *cluster-admin*
18-
privileges can enable the Custom build strategy, as referenced in the
19-
restricting build strategies to a user globally section.
20-
21-
You can control who can build and which build strategies they can use by using
22-
an authorization policy. Each build strategy has a corresponding build
23-
subresource. A user must have permission to create a build _and_ permission to
24-
create on the build strategy subresource in order to create builds using that
25-
strategy. Default roles are provided which grant the *create* permission on the
26-
build strategy subresource.
7+
Builds in {product-title} are run in privileged containers. Depending on the build strategy used, if you have privileges, you can run builds to escalate their permissions on the cluster and host nodes. And as a security measure, it limits who can run builds and the strategy that is used for those builds. Custom builds are inherently less safe than source builds, because they can execute any code within a privileged container, and are disabled by default. Grant docker build permissions with caution, because a vulnerability in the Dockerfile processing logic could result in a privileges being granted on the host node.
8+
9+
By default, all users that can create builds are granted permission to use the docker and Source-to-image (S2I) build strategies. Users with cluster administrator privileges can enable the custom build strategy, as referenced in the restricting build strategies to a user globally section.
10+
11+
You can control who can build and which build strategies they can use by using an authorization policy. Each build strategy has a corresponding build subresource. A user must have permission to create a build and permission to create on the build strategy subresource to create builds using that strategy. Default roles are provided that grant the create permission on the build strategy subresource.
2712

2813
.Build Strategy Subresources and Roles
2914
[options="header"]

builds/setting-up-trusted-ca.adoc

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -5,46 +5,46 @@ include::modules/common-attributes.adoc[]
55
toc::[]
66

77
ifdef::openshift-enterprise,openshift-webscale,openshift-origin[]
8-
Use the following sections to set up additional certificate authorities (CA) to be trusted by builds when pulling images
9-
from an image registry.
8+
Use the following sections to set up additional certificate authorities (CA) to be trusted by builds when pulling images from an image registry.
109

11-
The procedure requires a cluster administrator to create a ConfigMap and add additional CAs as keys in the ConfigMap.
10+
The procedure requires a cluster administrator to create a `ConfigMap` and add additional CAs as keys in the `ConfigMap`.
1211

13-
* The ConfigMap must be created in the `openshift-config` namespace.
14-
* `domain` is the key in the ConfigMap; `value` is the PEM-encoded certificate.
12+
* The `ConfigMap` must be created in the `openshift-config` namespace.
13+
* `domain` is the key in the `ConfigMap` and `value` is the PEM-encoded certificate.
1514
** Each CA must be associated with a domain. The domain format is `hostname[..port]`.
16-
* The ConfigMap name must be set in the `image.config.openshift.io/cluster` cluster scoped configuration resource's `spec.additionalTrustedCA` field.
15+
* The `ConfigMap` name must be set in the `image.config.openshift.io/cluster` cluster scoped configuration resource's `spec.additionalTrustedCA` field.
1716
//* No longer needs single PEM bundle
1817

1918
include::modules/configmap-adding-ca.adoc[leveloffset=+1]
2019

2120
== Additional resources
2221

23-
* link:https://kubernetes.io/docs/tasks/configure-pod-container/configure-pod-configmap/#create-a-configmap[Create a ConfigMap]
24-
* link:https://kubectl.docs.kubernetes.io/pages/app_management/secrets_and_configmaps.html[Secrets and ConfigMaps]
22+
* link:https://kubernetes.io/docs/tasks/configure-pod-container/configure-pod-configmap/#create-a-configmap[Create a `ConfigMap`]
23+
* link:https://kubectl.docs.kubernetes.io/guides/config_management/secrets_configmaps/[Secrets and `ConfigMaps`]
2524
* xref:../networking/configuring-a-custom-pki.adoc#configuring-a-custom-pki[Configuring a custom PKI]
2625
endif::[]
26+
27+
2728
ifdef::openshift-dedicated[]
28-
Use the following sections to set up additional certificate authorities (CA) to be trusted by builds when pulling images
29-
from an image registry.
29+
Use the following sections to set up additional certificate authorities (CA) to be trusted by builds when pulling images from an image registry.
3030

31-
The procedure requires a Dedicated administrator to create a ConfigMap and add additional CAs as keys in the ConfigMap.
31+
The procedure requires a Dedicated administrator to create a `ConfigMap` and add additional CAs as keys in the `ConfigMap`.
3232

33-
* The ConfigMap must be created in the `openshift-config` namespace.
34-
* `domain` is the key in the ConfigMap; `value` is the PEM-encoded certificate.
33+
* The `ConfigMap` must be created in the `openshift-config` namespace.
34+
* `domain` is the key in the `ConfigMap` and `value` is the PEM-encoded certificate.
3535
** Each CA must be associated with a domain. The domain format is `hostname[..port]`.
36-
* The ConfigMap name must be set in the `image.config.openshift.io/cluster` cluster scoped configuration resource's `spec.additionalTrustedCA` field.
36+
* The `ConfigMap` name must be set in the `image.config.openshift.io/cluster` cluster scoped configuration resource's `spec.additionalTrustedCA` field.
3737
//* No longer needs single PEM bundle
3838

3939
[NOTE]
4040
====
41-
{product-title} administrators are required to use the `registry-cas` ConfigMap.
41+
{product-title} administrators are required to use the `registry-cas` `ConfigMap`.
4242
====
4343

4444
include::modules/configmap-adding-ca.adoc[leveloffset=+1]
4545

4646
== Additional resources
4747

4848
* link:https://kubernetes.io/docs/tasks/configure-pod-container/configure-pod-configmap/#create-a-configmap[Create a ConfigMap]
49-
* link:https://kubectl.docs.kubernetes.io/pages/app_management/secrets_and_configmaps.html[Secrets and ConfigMaps]
49+
* link:https://kubectl.docs.kubernetes.io/guides/config_management/secrets_configmaps/[Secrets and ConfigMaps]
5050
endif::[]

builds/triggering-builds-build-hooks.adoc

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,7 @@ include::modules/common-attributes.adoc[]
44
:context: triggering-builds-build-hooks
55
toc::[]
66

7-
The following sections outline how to trigger builds and modify builds using
8-
build hooks.
9-
10-
// The following include statements pull in the module files that comprise the assembly. Include any combination of concept, procedure, or reference modules required to cover the user story. You can also include other assemblies.
7+
The following sections outline how to trigger builds and modify builds using build hooks.
118

129
include::modules/builds-triggers.adoc[leveloffset=+1]
1310

0 commit comments

Comments
 (0)