From e0fa8ae4727ed97737a782fe4962c3a856991590 Mon Sep 17 00:00:00 2001 From: Gaurav Nelson Date: Thu, 2 Nov 2017 15:49:11 +1000 Subject: [PATCH] [enterprise-3.7] changed all instances of emptydir and EmptyDir to emptyDir (cherry picked from commit fdd8a09f70db154f3f883bf29c96a0e79d50d45e) https://github.com/openshift/openshift-docs/pull/6084 --- architecture/additional_concepts/storage.adoc | 14 +++--- creating_images/guidelines.adoc | 2 +- dev_guide/application_lifecycle/new_app.adoc | 2 +- dev_guide/volumes.adoc | 4 +- getting_started/devpreview_faq.adoc | 50 +++++++------------ install_config/cluster_metrics.adoc | 4 +- install_config/install/advanced_install.adoc | 4 +- release_notes/ose_3_1_release_notes.adoc | 2 +- release_notes/ose_3_2_release_notes.adoc | 2 +- using_images/other_images/jenkins.adoc | 2 +- 10 files changed, 35 insertions(+), 51 deletions(-) diff --git a/architecture/additional_concepts/storage.adoc b/architecture/additional_concepts/storage.adoc index f8a0de448b1a..e41522ec5ab9 100644 --- a/architecture/additional_concepts/storage.adoc +++ b/architecture/additional_concepts/storage.adoc @@ -356,9 +356,9 @@ ifdef::openshift-dedicated[] ==== * PVs are provisioned with either EBS volumes (AWS) or GCP storage (GCP), depending on where the cluster is provisioned. * Only RWO access mode is applicable, since EBS volumes and GCE Persistent Disks cannot be mounted to multiple nodes. - * *EmptyDir* has the same lifecycle as the pod: - ** *EmptyDir* volumes survive container crashes/restarts. - ** *EmptyDir* volumes are deleted when the pod is deleted. + * *emptyDir* has the same lifecycle as the pod: + ** *emptyDir* volumes survive container crashes/restarts. + ** *emptyDir* volumes are deleted when the pod is deleted. ==== endif::[] @@ -369,12 +369,12 @@ ifdef::openshift-online[] * Only RWO access access mode is applicable, since EBS volumes and GCE Persistent Disks cannot be mounted to to multiple nodes. * Docker volumes are disabled. ** VOLUME directive without a mapped external volume fails to be instantiated. - * *EmptyDir* is restricted to 512 Mi per project (group) per node. + * *emptyDir* is restricted to 512 Mi per project (group) per node. ** If there is a single pod for a project on a particular node, then the pod can consume up to 512 Mi of *emptyDir* storage. ** If there are multiple pods for a project on a particular node, then those pods will share the 512 Mi of *emptyDir* storage. - * *EmptyDir* has the same lifecycle as the pod: - ** *EmptyDir* volumes survive container crashes/restarts. - ** *EmptyDir* volumes are deleted when the pod is deleted. + * *emptyDir* has the same lifecycle as the pod: + ** *emptyDir* volumes survive container crashes/restarts. + ** *emptyDir* volumes are deleted when the pod is deleted. ==== endif::[] diff --git a/creating_images/guidelines.adoc b/creating_images/guidelines.adoc index 44af7ae5f7a1..5e760a433f14 100644 --- a/creating_images/guidelines.adoc +++ b/creating_images/guidelines.adoc @@ -243,7 +243,7 @@ ifdef::openshift-online[] Docker images cannot be built using the `VOLUME` directive in the `DOCKERFILE`. Images using a read/write file system need to use persistent volumes or -`emptydir` volumes instead of local storage. Instead of specifying a volume in +`emptyDir` volumes instead of local storage. Instead of specifying a volume in the Dockerfile, specify a directory for local storage and mount either a persistent volume or `emptyDir` volume to that directory when deploying the pod. endif::[] diff --git a/dev_guide/application_lifecycle/new_app.adoc b/dev_guide/application_lifecycle/new_app.adoc index 06026ae72ed5..eea71a288e52 100644 --- a/dev_guide/application_lifecycle/new_app.adoc +++ b/dev_guide/application_lifecycle/new_app.adoc @@ -338,7 +338,7 @@ as input to `new-app`, then an image stream is created for that image as well. a|`DeploymentConfig` a|A `DeploymentConfig` is created either to deploy the output of a build, or a -specified image. The `new-app` command creates xref:../volumes.adoc#dev-guide-volumes[*EmptyDir* +specified image. The `new-app` command creates xref:../volumes.adoc#dev-guide-volumes[*emptyDir* volumes] for all Docker volumes that are specified in containers included in the resulting `DeploymentConfig`. diff --git a/dev_guide/volumes.adoc b/dev_guide/volumes.adoc index ff40b04e65d4..f07661d4762b 100644 --- a/dev_guide/volumes.adoc +++ b/dev_guide/volumes.adoc @@ -22,14 +22,14 @@ are present, to repair them when possible, {product-title} invokes the `fsck` utility prior to the `mount` utility. This occurs when either adding a volume or updating an existing volume. -The simplest volume type is `EmptyDir`, which is a temporary directory on a +The simplest volume type is `emptyDir`, which is a temporary directory on a single machine. Administrators may also allow you to request a xref:persistent_volumes.adoc#dev-guide-persistent-volumes[persistent volume] that is automatically attached to your pods. [NOTE] ==== -`EmptyDir` volume storage may be restricted by a quota based on the pod's +`emptyDir` volume storage may be restricted by a quota based on the pod's FSGroup, if the FSGroup parameter is enabled by your cluster administrator. ==== diff --git a/getting_started/devpreview_faq.adoc b/getting_started/devpreview_faq.adoc index 167ef0e5b559..8d24b78780e5 100644 --- a/getting_started/devpreview_faq.adoc +++ b/getting_started/devpreview_faq.adoc @@ -13,7 +13,7 @@ toc::[] == Overview -During the {product-title} 3 Developer Preview, consult the following sections +During the {product-title} (Next Gen) Developer Preview, consult the following sections for frequently asked questions and xref:devpreview-current-usage-considerations[current usage considerations] during the preview period. @@ -34,12 +34,12 @@ plan for the current (v2) offering and provide you with adequate time to migrate applications to the new platform. WHAT ARE THE RESOURCE LIMITS DURING THE DEVELOPER PREVIEW?:: -Each user can create 1 project with up to 2 GiB memory, 4 CPU cores, and 2 x 1 +Each user can create a single project with up to 2 GiB memory, 4 CPU cores, and 2 x 1 GiB persistent volumes. For more detailed limits, see the *Settings* tab on your project's Overview page in the web console. HOW LONG WILL I HAVE ACCESS TO THE ENVIRONMENT?:: -You will have access to the {product-title} 3 Developer Preview environment for +You will have access to the {product-title} (Next Gen) Developer Preview environment for 30 days, at which point your account will expire. WHAT HAPPENS WHEN MY ACCOUNT EXPIRES?:: @@ -49,38 +49,21 @@ longer be able to log in to the web console, authenticate using the {product-tit CLI tools, or access your applications and related data. CAN I CREATE A NEW ACCOUNT AFTER MY ACCOUNT EXPIRES?:: -If you are interested in trying the {product-title} 3 Developer Preview again, +If you are interested in trying the {product-title} (Next Gen) Developer Preview again, just complete the registration form after your account expires and we will provision a fresh set of resources for you as soon as they become available. -WHAT LANGUAGES ARE SUPPORTED?:: -The {product-title} 3 Developer Preview currently supports: +WHAT LANGUAGES AND DATABASE SERVICES ARE SUPPORTED?:: +The {product-title} (Next Gen) Developer Preview currently supports a number of developer languages and database services, including JBoss Middleware services. -- Node.js (0.10) -- PHP (5.5, 5.6) -- Python (2.7, 3.3, 3.4) -- Ruby (2.0, 2.2) -- Perl (5.16, 5.20) -- Java (6, 7, 8, EE) is available via optional JBoss Middleware Services (JBoss -EAP and JBoss Web Server) - -WHAT DATABASE SERVICES ARE SUPPORTED?:: -The {product-title} 3 Developer Preview currently supports: - -- MongoDB (2.4, 2.6) -- MySQL (5.5, 5.6) -- PostgreSQL (9.2, 9.4) - -WHAT JBOSS MIDDLEWARE SERVICES ARE AVAILABLE IN THE DEVELOPER PREVIEW?:: -JBoss EAP and JBoss Web Server are available to try during the {product-title} -(Next Gen) Developer Preview. +See the link:https://www.openshift.com/features/cartridges.html#online3[OpenShift features page] for the list of available languages and services. CAN USERS RUN IMAGES FROM DOCKER HUB OR PUSH THEIR OWN IMAGES TO THE REGISTRY?:: Yes, but with a few caveats. For https://docs.docker.com/engine/security/security/[security reasons], no images that run processes as root are allowed. Additionally, any Dockerfile `VOLUME` instruction must be mounted with either a persistent volume claim (PVC) or an -EmptyDir at this time. See xref:devpreview-current-usage-considerations[more +emptyDir at this time. See xref:devpreview-current-usage-considerations[more considerations]. CAN I RUN PRODUCTION SERVICES ON THE DEVELOPER PREVIEW?:: @@ -93,9 +76,9 @@ to see how it performs in the environment. == Pricing HOW AM I BILLED?:: -During our Developer Preview period, {product-title} 3 is FREE! +During our Developer Preview period, {product-title} (Next Gen) is FREE! -ARE PAID PLANS AVAILABLE FOR {product-title} (NEXT GEN)?:: +ARE PAID PLANS AVAILABLE FOR OPENSHIFT (NEXT GEN)?:: Not at this time. {product-title} (Next Gen) will offer paid tiers when the offering becomes generally available. @@ -108,7 +91,7 @@ During our Developer Preview period, we do not offer a Service Level Agreement HOW CAN I FIND OUT ABOUT PRODUCT UPDATES AND SCHEDULED MAINTENANCE?:: Red Hat will provide updates via -http://status.openshift.com[status.openshift.com]. +http://status.preview.openshift.com[status.preview.openshift.com]. [[devpreview-faq-support]] == Support @@ -147,20 +130,21 @@ selected with the provided link). [[devpreview-current-usage-considerations]] == Current Usage Considerations -The {product-title} 3 Developer Preview offering scopes the inventory of images +The {product-title} (Next Gen) Developer Preview offering scopes the inventory of images it provides out of the box with a few considerations in mind, which also apply to any images you choose to import into your project. These conditions are enforced via the {product-title} xref:../dev_guide/compute_resources.adoc#dev-guide-compute-resources[quotas, limit ranges, and compute resources] systems. -* A memory limit of 2GiB is in place. The 2 GiB is spread out across the project's -pods and containers. +* A memory limit of 2 GiB is in place for a project. The 2 GiB is spread out +across the project's pods and containers. Individual pods and containers have a +limit of 1 GiB each. * Maximum counts are in place for pods, replication controllers, services, and secrets (though some amount of these secrets will be needed by the system's build and deployer service accounts). * Any Dockerfile `VOLUME` instruction must be mounted with either a persistent -volume claim (PVC) or an EmptyDir at this time. -* The project associated with a user can allocate up to two PVCs. +volume claim (PVC) or an emptyDir at this time. +* The project associated with a user can allocate up to two PVCs of up to 1 GiB each. * No images that run as *root* are allowed. * Only the Source-to-Image (S2I) build strategy is allowed for any build configurations imported into your project. diff --git a/install_config/cluster_metrics.adoc b/install_config/cluster_metrics.adoc index 5444ad5514e3..fa0e1f7b88c0 100644 --- a/install_config/cluster_metrics.adoc +++ b/install_config/cluster_metrics.adoc @@ -306,7 +306,7 @@ metrics can still survive a container being restarted. In order to use non-persistent storage, you must set the `openshift_metrics_cassandra_storage_type` xref:../install_config/cluster_metrics.adoc#metrics-ansible-variables[variable] -to `emptydir` in the inventory file. +to `emptyDir` in the inventory file. [NOTE] ==== @@ -382,7 +382,7 @@ appended to the prefix starting from 1. |The persistent volume claim size for each of the Cassandra nodes. |`openshift_metrics_cassandra_storage_type` -|Use `emptydir` for ephemeral storage (for testing); `pv` for persistent volumes, +|Use `emptyDir` for ephemeral storage (for testing); `pv` for persistent volumes, which need to be created before the installation; or `dynamic` for dynamic persistent volumes. diff --git a/install_config/install/advanced_install.adoc b/install_config/install/advanced_install.adoc index 115c3da89cf3..1a2d2f4b529c 100644 --- a/install_config/install/advanced_install.adoc +++ b/install_config/install/advanced_install.adoc @@ -1417,7 +1417,7 @@ If you alter this variable, ensure the host name is accessible via your router. The `openshift_metrics_cassandra_storage_type` variable must be set in order to use persistent storage for metrics. If `openshift_metrics_cassandra_storage_type` is not set, then cluster metrics data -is stored in an `EmptyDir` volume, which will be deleted when the Cassandra pod +is stored in an `emptyDir` volume, which will be deleted when the Cassandra pod terminates. There are three options for enabling cluster metrics storage when using the @@ -1494,7 +1494,7 @@ openshift_logging_install_logging=true The `openshift_logging_storage_kind` variable must be set in order to use persistent storage for logging. If `openshift_logging_storage_kind` is -not set, then cluster logging data is stored in an `EmptyDir` volume, which will +not set, then cluster logging data is stored in an `emptyDir` volume, which will be deleted when the Elasticsearch pod terminates. There are three options for enabling cluster logging storage when using the diff --git a/release_notes/ose_3_1_release_notes.adoc b/release_notes/ose_3_1_release_notes.adoc index 63f378a85ee2..1d91304b745b 100644 --- a/release_notes/ose_3_1_release_notes.adoc +++ b/release_notes/ose_3_1_release_notes.adoc @@ -252,7 +252,7 @@ https://bugzilla.redhat.com/show_bug.cgi?id=1275388[BZ#1275388]:: Previously, so https://bugzilla.redhat.com/show_bug.cgi?id=1265187[BZ#1265187]:: When persistent volume claims (PVC) were created from a template, sometimes the same volume would be mounted to multiple PVCs. At the same time, the volume would show that only one PVC was being used. The issue has been fixed. https://bugzilla.redhat.com/show_bug.cgi?id=1279308[BZ#1279308]:: Previously, using a etcd storage location other than the default, as defined in the master configuration file, would result in an upgrade fail at the "generate etcd backup" stage. This issue has now been fixed. https://bugzilla.redhat.com/show_bug.cgi?id=1276599[BZ#1276599]:: Basic authentication passwords can now contain colons. -https://bugzilla.redhat.com/show_bug.cgi?id=1279744[BZ#1279744]:: Previously, giving `*EmptyDir*` volumes a different default permission setting and group ownership could affect deploying the *postgresql-92-rhel7* image. The issue has been fixed. +https://bugzilla.redhat.com/show_bug.cgi?id=1279744[BZ#1279744]:: Previously, giving `*emptyDir*` volumes a different default permission setting and group ownership could affect deploying the *postgresql-92-rhel7* image. The issue has been fixed. https://bugzilla.redhat.com/show_bug.cgi?id=1276395[BZ#1276395]:: Previously, an error could occur when trying to perform an HA install using Ansible, due to a problem with SRC files. The issue has been fixed. https://bugzilla.redhat.com/show_bug.cgi?id=1267733[BZ#1267733]:: When installing a etcd cluster with hosts with different network interfaces, the install would fail. The issue has been fixed. https://bugzilla.redhat.com/show_bug.cgi?id=1274239[BZ#1274239]:: Previously, when changing the default project region from *infra* to *primary*, old route and registry pods are stuck in the terminating stage and could not be deleted, meaning that new route and registry pods could not be deployed. The issue has been fixed. diff --git a/release_notes/ose_3_2_release_notes.adoc b/release_notes/ose_3_2_release_notes.adoc index 0458856c1b0c..bf3fd483a1c2 100644 --- a/release_notes/ose_3_2_release_notes.adoc +++ b/release_notes/ose_3_2_release_notes.adoc @@ -130,7 +130,7 @@ Authentication] for details. - The `SETUID` and `SETGID` capabilities have been added back to the *anyuid* SCC, which ensures that programs that start as root and then drop to a lower permission level will work by default. -- Quota support has been added for `*emptydir*`. When the quota is enabled on an +- Quota support has been added for `*emptyDir*`. When the quota is enabled on an XFS system, nodes will limit the amount of space any given project can use on a node to a fixed upper bound. The quota is tied to the `*FSGroup*` of the project. Administrators can control this value by editing the project directly diff --git a/using_images/other_images/jenkins.adoc b/using_images/other_images/jenkins.adoc index d6c24a1a555c..d61804b1254b 100644 --- a/using_images/other_images/jenkins.adoc +++ b/using_images/other_images/jenkins.adoc @@ -339,7 +339,7 @@ are already installed. $ oc new-app jenkins-persistent ---- -.. Or an `EmptyDir` type volume (where configuration does not persist across pod restarts): +.. Or an `emptyDir` type volume (where configuration does not persist across pod restarts): ---- $ oc new-app jenkins-ephemeral ----