|
| 1 | +:_mod-docs-content-type: ASSEMBLY |
| 2 | +[id="about-disconnected-environments"] |
| 3 | += About disconnected environments |
| 4 | +include::_attributes/common-attributes.adoc[] |
| 5 | +:context: about-disconnected-environments |
| 6 | + |
| 7 | +toc::[] |
| 8 | + |
| 9 | +A disconnected environment is an environment that does not have full access to the internet. |
| 10 | + |
| 11 | +{product-title} is designed to perform many automatic functions that depend on an internet connection, such as retrieving release images from a registry or retrieving update paths and recommendations for the cluster. |
| 12 | +Without a direct internet connection, you must perform additional setup and configuration for your cluster to maintain full functionality in the disconnected environment. |
| 13 | + |
| 14 | +[id="glossary-disconnected_{context}"] |
| 15 | +== Glossary of disconnected environment terms |
| 16 | + |
| 17 | +Although it is used throughout the {product-title} documentation, _disconnected environment_ is a broad term that can refer to environments with various levels of internet connectivity. |
| 18 | +Other terms are sometimes used to refer to a specific level of internet connectivity, and these environments might require additional unique configurations. |
| 19 | + |
| 20 | +The following table describes the different terms used to refer to environments without a full internet connection: |
| 21 | + |
| 22 | +.Disconnected environment terms |
| 23 | +[cols=".^2,.^4",options="header"] |
| 24 | +|==== |
| 25 | +|Term |Description |
| 26 | + |
| 27 | +|Air-gapped network |
| 28 | +|An environment or network that is completely isolated from an external network. |
| 29 | + |
| 30 | +This isolation depends on a physical separation, or an "air gap", between machines on the internal network and any other part of an external network. |
| 31 | +Air-gapped environments are often used in industries with strict security or regulatory requirements. |
| 32 | + |
| 33 | +|Disconnected environment |
| 34 | +|An environment or network that has some level of isolation from an external network. |
| 35 | + |
| 36 | +This isolation could be enabled by physical or logical separation between machines on the internal network and an external network. |
| 37 | +Regardless of the level of isolation from the external network, a cluster in a disconnected environment does not have access to public services hosted by Red{nbsp}Hat and requires additional setup to maintain full cluster functionality. |
| 38 | + |
| 39 | +|Restricted Network |
| 40 | +|An environment or network with limited connection to an external network. |
| 41 | + |
| 42 | +A physical connection may exist between machines on the internal network and an external network, but network traffic is limited by additional configurations, such as with firewalls and proxies. |
| 43 | +|==== |
| 44 | + |
| 45 | +[id="preferred-methods_{context}"] |
| 46 | +== Preferred methods for working with disconnected environments |
| 47 | + |
| 48 | +// Not sure about the heading above, I'm trying to find some phrasing that basically says "You should probably use these things if you don't have a strong reason to go with other options". |
| 49 | + |
| 50 | +You can choose between multiple options for most aspects of managing a cluster in a disconnected environment. |
| 51 | +For example, when mirroring images you can choose between using the oc-mirror {oc-first} plugin or using the `oc adm` command. |
| 52 | + |
| 53 | +However, some options provide a simpler and more convenient user experience for disconnected environments, and are the preferred method over their alternatives. |
| 54 | + |
| 55 | +Unless your organizational needs require you to choose another option, use the following methods for mirroring images, installing your cluster, and updating your cluster: |
| 56 | + |
| 57 | +* Mirror your images using the xref:../disconnected/mirroring/installing-mirroring-disconnected.adoc#installing-mirroring-disconnected[oc-mirror plugin]. |
| 58 | + |
| 59 | +* Install your cluster using the xref:../installing/installing_with_agent_based_installer/installing-with-agent-based-installer.adoc#installing-with-agent-based-installer[Agent-based Installer]. |
| 60 | + |
| 61 | +* Update your cluster using a xref:../disconnected/updating/disconnected-update-osus.adoc#updating-disconnected-cluster-osus[local OpenShift Update Service instance]. |
0 commit comments