mirror of
https://github.com/openshift/openshift-docs.git
synced 2026-02-05 21:46:22 +01:00
Makes asciidocdita vale changes to S2I content
This commit is contained in:
Steven Smith
committed by
openshift-cherrypick-robot
openshift-cherrypick-robot
parent
ae83c25c94
commit
f8aae3d3f3
@@ -0,0 +1,23 @@
|
||||
// Module included in the following assemblies:
|
||||
//
|
||||
// * openshift_images/using_images/using-images-source-to-image.adoc
|
||||
|
||||
:_mod-docs-content-type: PROCEDURE
|
||||
[id="accessing-s2i-builder-images-in-developer-console_{context}"]
|
||||
= Accessing S2I builder images in the {product-title} Developer Console
|
||||
|
||||
[role="_abstract"]
|
||||
You can access S2I builder images through the Developer Console in the web console.
|
||||
You need these images to build containerized applications from your source code.
|
||||
|
||||
.Procedure
|
||||
|
||||
. Log in to the {product-title} web console using your login credentials. The default view for the {product-title} web console is the *Administrator* perspective.
|
||||
|
||||
. Use the perspective switcher to switch to the *Developer* perspective.
|
||||
|
||||
. In the *+Add* view, use the *Project* drop-down list to select an existing project or create a new project.
|
||||
|
||||
. Click *All services* in the *Developer Catalog* tile.
|
||||
|
||||
. Click *Builder Images* under *Type* to see the available S2I images.
|
||||
@@ -5,7 +5,8 @@
|
||||
[id="containers-about_{context}"]
|
||||
= Containers
|
||||
|
||||
The basic units of {product-title} applications are called containers. link:https://www.redhat.com/en/topics/containers#overview[Linux container technologies] are lightweight mechanisms for isolating running processes so that they are limited to interacting with only their designated resources. The word container is defined as a specific running or paused instance of a container image.
|
||||
[role="_abstract"]
|
||||
The basic units of {product-title} applications are called containers. link:https://www.redhat.com/en/topics/containers#overview[Linux container technologies] are lightweight mechanisms for isolating running processes so that they are limited to interacting with only their designated resources. The word container is defined as _a specific running or paused instance of a container image_.
|
||||
|
||||
Many application instances can be running in containers on a single host without visibility into each others' processes, files, network, and so on. Typically, each container provides a single service, often called a micro-service, such as a web server or a database, though containers can be used for arbitrary workloads.
|
||||
|
||||
@@ -13,4 +14,4 @@ The Linux kernel has been incorporating capabilities for container technologies
|
||||
|
||||
Though you do not directly interact with container runtimes when using {product-title}, understanding their capabilities and terminology is important for understanding their role in {product-title} and how your applications function inside of containers.
|
||||
|
||||
Tools such as link:https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux_atomic_host/7/html-single/managing_containers/#using_podman_to_work_with_containers[podman] can be used to replace `docker` command-line tools for running and managing containers directly. Using `podman`, you can experiment with containers separately from {product-title}.
|
||||
Tools such as link:https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux_atomic_host/7/html-single/managing_containers/#using_podman_to_work_with_containers[Podman] can be used to replace Docker command-line tools for running and managing containers directly. By using the `podman` CLI, you can experiment with containers separately from {product-title}.
|
||||
|
||||
@@ -5,9 +5,10 @@
|
||||
[id="images-about_{context}"]
|
||||
= Images
|
||||
|
||||
Containers in {product-title} are based on OCI- or Docker-formatted container _images_. An image is a binary that includes all of the requirements for running a single container, as well as metadata describing its needs and capabilities.
|
||||
[role="_abstract"]
|
||||
Container images are binaries that include all requirements for running a single container. You can use images to package applications and deploy them across multiple containers and hosts in {product-title}.
|
||||
|
||||
You can think of it as a packaging technology. Containers only have access to resources defined in the image unless you give the container additional access when creating it. By deploying the same image in multiple containers across multiple hosts and load balancing between them, {product-title} can provide redundancy and horizontal scaling for a service packaged into an image.
|
||||
Containers only have access to resources defined in the image unless you give the container additional access when creating it. By deploying the same image in multiple containers across multiple hosts and load balancing between them, {product-title} can provide redundancy and horizontal scaling for a service packaged into an image.
|
||||
|
||||
You can use the link:https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux_atomic_host/7/html-single/managing_containers/#using_podman_to_work_with_containers[podman] or `docker` CLI directly to build images, but {product-title} also supplies builder images that assist with creating new images by adding your code or configuration to existing images.
|
||||
|
||||
|
||||
@@ -5,7 +5,10 @@
|
||||
[id="images-container-repository-about_{context}"]
|
||||
= Image repository
|
||||
|
||||
An image repository is a collection of related container images and tags identifying them. For example, the {product-title} Jenkins images are in the repository:
|
||||
[role="_abstract"]
|
||||
An image repository is a collection of related container images and tags identifying them. You can use image repositories to organize and manage related container images in {product-title}.
|
||||
|
||||
For example, the {product-title} Jenkins images are in the following repository:
|
||||
|
||||
[source,text]
|
||||
----
|
||||
|
||||
@@ -5,7 +5,10 @@
|
||||
[id="images-id_{context}"]
|
||||
= Image IDs
|
||||
|
||||
An image ID is a SHA (Secure Hash Algorithm) code that can be used to pull an image. A SHA image ID cannot change. A specific SHA identifier always references the exact same container image content. For example:
|
||||
[role="_abstract"]
|
||||
Image IDs are Secure Hash Algorithm (SHA) codes that uniquely identify container images. You can use image IDs to pull specific versions of images that never change.
|
||||
|
||||
For example, the following image ID is for the `docker.io/openshift/jenkins-2-centos7` image:
|
||||
|
||||
[source,text]
|
||||
----
|
||||
|
||||
@@ -5,11 +5,8 @@
|
||||
[id="images-image-registry-about_{context}"]
|
||||
= Image registry
|
||||
|
||||
An image registry is a content server that can store and serve container images. For example:
|
||||
[role="_abstract"]
|
||||
An image registry is a content server that stores and serves container images.
|
||||
You can use registries to access container images from external sources or {product-title}'s integrated registry.
|
||||
|
||||
[source,text]
|
||||
----
|
||||
registry.redhat.io
|
||||
----
|
||||
|
||||
A registry contains a collection of one or more image repositories, which contain one or more tagged images. Red Hat provides a registry at `registry.redhat.io` for subscribers. {product-title} can also supply its own {product-registry} for managing custom container images.
|
||||
Registries contain a collection of one or more image repositories, which contain one or more tagged images. Red{nbsp}Hat provides a registry at link:https://catalog.redhat.com/en[registry.redhat.io] for subscribers. {product-title} can also supply its own {product-registry} for managing custom container images.
|
||||
|
||||
@@ -5,4 +5,6 @@
|
||||
[id="images-imagestream-image_{context}"]
|
||||
= Image stream images
|
||||
|
||||
An image stream image allows you to retrieve a specific container image from a particular image stream where it is tagged. An image stream image is an API resource object that pulls together some metadata about a particular image SHA identifier.
|
||||
[role="_abstract"]
|
||||
Image stream images are API resource objects that retrieve specific container images from image streams.
|
||||
You can use image stream images to access metadata about particular image SHA identifiers in {product-title}.
|
||||
|
||||
@@ -5,4 +5,5 @@
|
||||
[id="images-imagestream-tag_{context}"]
|
||||
= Image stream tags
|
||||
|
||||
An image stream tag is a named pointer to an image in an image stream. An image stream tag is similar to a container image tag.
|
||||
[role="_abstract"]
|
||||
Image stream tags are named pointers to images in image streams. You can configure image stream tags to reference specific versions of container images.
|
||||
|
||||
@@ -5,4 +5,7 @@
|
||||
[id="images-imagestream-trigger_{context}"]
|
||||
= Image stream triggers
|
||||
|
||||
An image stream trigger causes a specific action when an image stream tag changes. For example, importing can cause the value of the tag to change, which causes a trigger to fire when there are deployments, builds, or other resources listening for those.
|
||||
[role="_abstract"]
|
||||
Image stream triggers cause specific actions when image stream tags change. You can configure triggers to automatically start builds or deployments when new images are imported.
|
||||
|
||||
For example, importing a new image can cause the value of the tag to change, which causes a trigger to fire when there are deployments, builds, or other resources listening for those.
|
||||
@@ -4,9 +4,10 @@
|
||||
|
||||
:_mod-docs-content-type: CONCEPT
|
||||
[id="images-imagestream-use_{context}"]
|
||||
= Why use imagestreams
|
||||
= Using image streams
|
||||
|
||||
An image stream and its associated tags provide an abstraction for referencing container images from within {product-title}. The image stream and its tags allow you to see what images are available and ensure that you are using the specific image you need even if the image in the repository changes.
|
||||
[role="_abstract"]
|
||||
Image streams provide an abstraction for referencing container images from within {product-title}. You can use image streams to manage image versions and automate builds and deployments.
|
||||
|
||||
Image streams do not contain actual image data, but present a single virtual view of related images, similar to an image repository.
|
||||
|
||||
|
||||
@@ -6,11 +6,13 @@
|
||||
[id="images-s2i-build-process-overview_{context}"]
|
||||
= Source-to-image build process overview
|
||||
|
||||
Source-to-image (S2I) produces ready-to-run images by injecting source code into a container that prepares that source code to be run. It performs the following steps:
|
||||
[role="_abstract"]
|
||||
Source-to-image (S2I) is a build process that injects your source code into a container image.
|
||||
S2I automates the creation of ready-to-run container images from your application source code. It performs the following steps:
|
||||
|
||||
. Runs the `FROM <builder image>` command
|
||||
. Copies the source code to a defined location in the builder image
|
||||
. Runs the assemble script in the builder image
|
||||
. Sets the run script in the builder image as the default command
|
||||
|
||||
Buildah then creates the container image.
|
||||
Buildah then creates the container image.
|
||||
@@ -6,7 +6,10 @@
|
||||
[id="images-tag_{context}"]
|
||||
= Image tags
|
||||
|
||||
An image tag is a label applied to a container image in a repository that distinguishes a specific image from other images in an image stream. Typically, the tag represents a version number of some sort. For example, here `:v3.11.59-2` is the tag:
|
||||
[role="_abstract"]
|
||||
Image tags are labels applied to container images in image streams to distinguish specific versions of images. They help you organize and reference specific versions of images in {product-title}.
|
||||
|
||||
Typically, an image tag represents a version number of some sort. The following example shows the `registry.access.redhat.com/openshift3/jenkins-2-rhel7` image with the tag `:v3.11.59-2`:
|
||||
|
||||
[source,text]
|
||||
----
|
||||
|
||||
@@ -6,7 +6,9 @@
|
||||
[id="images-using-customizing-s2i-images-scripts-embedded_{context}"]
|
||||
= Invoking scripts embedded in an image
|
||||
|
||||
Builder images provide their own version of the source-to-image (S2I) scripts that cover the most common use-cases. If these scripts do not fulfill your needs, S2I provides a way of overriding them by adding custom ones in the `.s2i/bin` directory. However, by doing this, you are completely replacing the standard scripts. In some cases, replacing the scripts is acceptable, but, in other scenarios, you can run a few commands before or after the scripts while retaining the logic of the script provided in the image. To reuse the standard scripts, you can create a wrapper script that runs custom logic and delegates further work to the default scripts in the image.
|
||||
[role="_abstract"]
|
||||
You invoke embedded S2I image scripts by creating wrapper scripts that run custom logic and default scripts.
|
||||
You must do this to extend builder image behavior while preserving supported script logic and upgrade compatibility.
|
||||
|
||||
.Procedure
|
||||
|
||||
|
||||
@@ -6,8 +6,13 @@ include::_attributes/common-attributes.adoc[]
|
||||
|
||||
toc::[]
|
||||
|
||||
[role="_abstract"]
|
||||
This section describes the concepts of containers, images, and image streams in {product-title}.
|
||||
Use this information to understand how containerized applications work in {product-title}.
|
||||
|
||||
[id="about-containers-images-and-image-streams"]
|
||||
== Understanding containers, images, and image streams
|
||||
|
||||
Containers, images, and image streams are important concepts to understand when you set out to create and manage containerized software.
|
||||
An image holds a set of software that is ready to run, while a container is a running instance of a container image.
|
||||
An image stream provides a way of storing different versions of the same basic image.
|
||||
@@ -78,11 +83,10 @@ As a developer, you can use Ruby on Rails to:
|
||||
|
||||
ifdef::openshift-rosa[]
|
||||
[role="_additional-resources"]
|
||||
[id="additional-resources_{context}"]
|
||||
== Additional resources
|
||||
|
||||
* To learn more about templates, see
|
||||
xref:../applications/creating_applications/using-templates.adoc#templates-overview[Understanding templates].
|
||||
* To learn more about Ruby on Rails, see
|
||||
xref:../applications/creating_applications/templates-using-ruby-on-rails.adoc#templates-using-ruby-on-rails[Creating applications using Ruby on Rails].
|
||||
* xref:../applications/creating_applications/using-templates.adoc#templates-overview[Understanding templates.]
|
||||
* xref:../applications/creating_applications/templates-using-ruby-on-rails.adoc#templates-using-ruby-on-rails[Creating applications using Ruby on Rails.]
|
||||
endif::openshift-rosa[]
|
||||
|
||||
|
||||
@@ -4,6 +4,10 @@
|
||||
include::_attributes/common-attributes.adoc[]
|
||||
:context: customizing-s2i-images
|
||||
|
||||
Source-to-image (S2I) builder images include assemble and run scripts, but the default behavior of those scripts is not suitable for all users. You can customize the behavior of an S2I builder that includes default scripts.
|
||||
toc::[]
|
||||
|
||||
[role="_abstract"]
|
||||
Customize source-to-image (S2I) builder images to modify the default assemble and run script behavior.
|
||||
You can adapt S2I builders to meet your specific application requirements when the default scripts are not suitable.
|
||||
|
||||
include::modules/images-using-customizing-s2i-images-scripts-embedded.adoc[leveloffset=+1]
|
||||
|
||||
@@ -6,13 +6,15 @@ include::_attributes/common-attributes.adoc[]
|
||||
|
||||
toc::[]
|
||||
|
||||
Use the following topics to discover the different Source-to-Image (S2I), database, and other container images that are available for {product-title} users.
|
||||
[role="_abstract"]
|
||||
You can use Source-to-Image (S2I), database, and other container images that are available for {product-title}.
|
||||
You need these images to build and deploy containerized applications on your cluster.
|
||||
|
||||
Red Hat official container images are provided in the Red Hat Registry at link:https://registry.redhat.io[registry.redhat.io]. {product-title}'s supported S2I, database, and Jenkins images are provided in the `openshift4` repository in the {quay} Registry. For example, `quay.io/openshift-release-dev/ocp-v4.0-<address>` is the name of the OpenShift Application Platform image.
|
||||
Red{nbsp}Hat official container images are provided in the Red{nbsp}Hat Registry at link:https://registry.redhat.io[registry.redhat.io]. {product-title}'s supported S2I, database, and Jenkins images are provided in the `openshift4` repository in the {quay} Registry. For example, `quay.io/openshift-release-dev/ocp-v4.0-<address>` is the name of the OpenShift Application Platform image.
|
||||
|
||||
The xPaaS middleware images are provided in their respective product repositories on the Red Hat Registry but suffixed with a `-openshift`. For example, `registry.redhat.io/jboss-eap-6/eap64-openshift` is the name of the JBoss EAP image.
|
||||
|
||||
All Red Hat supported images covered in this section are described in the link:https://catalog.redhat.com/software/containers/explore[Container images section of the Red Hat Ecosystem Catalog]. For every version of each image, you can find details on its contents and usage. Browse or search for the image that interests you.
|
||||
All Red{nbsp}Hat supported images covered in this section are described in the link:https://catalog.redhat.com/software/containers/explore[Container images section of the Red Hat Ecosystem Catalog]. For every version of each image, you can find details on its contents and usage. Browse or search for the image that interests you.
|
||||
|
||||
[IMPORTANT]
|
||||
====
|
||||
|
||||
@@ -6,29 +6,18 @@ include::_attributes/common-attributes.adoc[]
|
||||
|
||||
toc::[]
|
||||
|
||||
You can use the link:https://access.redhat.com/documentation/en-us/red_hat_software_collections/3/html-single/using_red_hat_software_collections_container_images/index[Red Hat Software Collections] images as a foundation for applications that rely on specific runtime environments such as Node.js, Perl, or Python. You can use the link:https://access.redhat.com/documentation/en-us/openjdk/11/html/using_openjdk_11_source-to-image_for_openshift/index[Red Hat Java Source-to-Image for OpenShift] documentation as a reference for runtime environments that use Java. Special versions of some of these runtime base images are referred to as Source-to-Image (S2I) images. With S2I images, you can insert your code into a base image environment that is ready to run that code.
|
||||
[role="_abstract"]
|
||||
Source-to-Image (S2I) images are special versions of runtime base images for languages like Node.js, Python, and Java.
|
||||
You can insert your code into S2I images to create containerized applications without configuring the runtime environment.
|
||||
|
||||
S2I images include:
|
||||
You can use the link:https://access.redhat.com/documentation/en-us/red_hat_software_collections/3/html-single/using_red_hat_software_collections_container_images/index[Red{nbsp}Hat Software Collections] images as a foundation for applications that rely on specific runtime environments such as Node.js, Perl, or Python.
|
||||
|
||||
* .NET
|
||||
* Java
|
||||
* Go
|
||||
* Node.js
|
||||
* Perl
|
||||
* PHP
|
||||
* Python
|
||||
* Ruby
|
||||
|
||||
S2I images are available for you to use directly from the {product-title} web console by following procedure:
|
||||
|
||||
. Log in to the {product-title} web console using your login credentials. The default view for the {product-title} web console is the *Administrator* perspective.
|
||||
. Use the perspective switcher to switch to the *Developer* perspective.
|
||||
. In the *+Add* view, use the *Project* drop-down list to select an existing project or create a new project.
|
||||
. Click *All services* in the *Developer Catalog* tile.
|
||||
. Click *Builder Images* under *Type* to see the available S2I images.
|
||||
You can use the link:https://docs.redhat.com/en/documentation/red_hat_build_of_openjdk/11/html/using_source-to-image_for_openshift_with_red_hat_build_of_openjdk_11/openjdk-overview-s2i-openshift[Introduction to source-to-image for OpenShift] documentation as a reference for runtime environments that use Java.
|
||||
|
||||
S2I images are also available though the xref:../../openshift_images/configuring-samples-operator.adoc#configuring-samples-operator[Cluster Samples Operator].
|
||||
|
||||
include::modules/accessing-s2i-builder-images-in-developer-console.adoc[leveloffset=+1]
|
||||
|
||||
include::modules/images-s2i-build-process-overview.adoc[leveloffset=+1]
|
||||
|
||||
[role="_additional-resources"]
|
||||
|
||||
Reference in New Issue
Block a user