diff --git a/_topic_map.yml b/_topic_map.yml index 0e360637f9..4c3b52feaa 100644 --- a/_topic_map.yml +++ b/_topic_map.yml @@ -42,6 +42,8 @@ Distros: openshift-* Topics: - Name: Architecture File: architecture +- Name: Available cluster customizations + File: customizations - Name: Web console File: web-console --- diff --git a/architecture/customizations.adoc b/architecture/customizations.adoc new file mode 100644 index 0000000000..9f3ad17e4c --- /dev/null +++ b/architecture/customizations.adoc @@ -0,0 +1,438 @@ +// This assembly is included in the following assemblies: +// +// * n/a + +[id='customizations'] += Available cluster customizations +include::modules/common-attributes.adoc[] +:context: customizations +toc::[] + +You complete most of the cluster configuration and customization after you +deploy your {product-title} cluster. By default, a number of +_configuration resources_ and _Custom Resources_ are available. + +You modify the configuration resources to define the major components of the +cluster, such as the networking configuration and the identity provider. + +You can also deploy Custom Resources (CRs) that are based on a number of +Custom Resource Definitions (CRDs) that are deployed on your cluster. + +[id='configuration-resources'] +== Configuration resources + + + +[cols="2a,5a",options="header"] +|=== +|Configuration resource |Description |Customizing the resource + +|Authentication +|You can configure the identity provider for your cluster. See +xref:../authentication/understanding-identity-provider.adoc#understanding-identity-provider[Understanding identity provider configuration]. + +|DNS +|See + +|Image +|See + +|Infrastructure +|In {product-title} 4.0, you cannot customize the infrastructure resource. + +|Ingress +|See + +|Network +|See + +|OAuth +|See +|=== + + +[id='default-crds-{context}'] +== Custom resources + +A number of Custom Resource Definitions (CRDs) are available for you to use to +further tune your {product-title} deployment. You can deploy Custom Resources +that are based on many of these CRDs to add more functionality to your +{product-title} cluster. + +.Default CRDs +[cols="2a,2a,8a,2a,2a",options="header"] +|=== +|Name +|Group +|Description +|Namespaced +|Can deploy CR + + +|Alertmanager +|monitoring.coreos.com +| +|Namespaced +| + +|AuthenticationOperatorConfig +|authentication.operator.openshift.io +| +|Not namespaced +| + +|Authentication +|config.openshift.io +| +|Not namespaced +| + +|Build +|config.openshift.io +| +|Not namespaced +| + +|CatalogSourceConfig +|marketplace.redhat.com +| +|Namespaced +| + +|CatalogSource +|operators.coreos.com +| +|Namespaced +| + +|ClusterAutoscaler +|autoscaling.openshift.io +| +|Not namespaced +|Yes + +|ClusterDNS +|dns.openshift.io +| +|Not namespaced +| + +|ClusterIngress +|ingress.openshift.io +| +|Namespaced +| + +|ClusterNetwork +|network.openshift.io +| +|Not namespaced +| + +|ClusterOperator +|config.openshift.io +| +|Not namespaced +| + +|ClusterOperator +|operatorstatus.openshift.io +| +|Namespaced +| + +|Cluster +|cluster.k8s.io +| +|Namespaced +| + +|Cluster +|machine.openshift.io +| +|Namespaced +| + +|ClusterServiceVersion +|operators.coreos.com +| +|Namespaced +| + +|ClusterVersion +|config.openshift.io +| +|Not namespaced +| + +|Config +|imageregistry.operator.openshift.io +| +|Not namespaced +| + +|Config +|samples.operator.openshift.io +| +|Not namespaced +| + +|Console +|console.openshift.io +| +|Namespaced +| + +|ControllerConfig +|machineconfiguration.openshift.io +| +|Not namespaced +| + +|CredentialsRequest +|cloudcredential.openshift.io +| +|Namespaced +| + +|DNS +|config.openshift.io +| +|Not namespaced +| + +|EgressNetworkPolicy +|network.openshift.io +| +|Namespaced +| + +|HostSubnet +|network.openshift.io +| +|Not namespaced +| + +|Image +|config.openshift.io +| +|Not namespaced +| + +|Infrastructure +|config.openshift.io +| +|Not namespaced +| + +|Ingress +|config.openshift.io +| +|Not namespaced +| + +|InstallPlan +|operators.coreos.com +| +|Namespaced +| + +|KubeAPIServerOperatorConfig +|kubeapiserver.operator.openshift.io +| +|Not namespaced +| + +|KubeControllerManager +|operator.openshift.io +| +|Not namespaced +| + +|KubeletConfig +|machineconfiguration.openshift.io +| +|Not namespaced +| + +|KubeSchedulerOperatorConfig +|kubescheduler.operator.openshift.io +| +|Not namespaced +| + +|MachineAutoscaler +|autoscaling.openshift.io +| +|Namespaced +|Yes + +|MachineClass +|cluster.k8s.io +| +|Namespaced +| + +|MachineClass +|machine.openshift.io +| +|Namespaced +| + +|MachineConfigPool +|machineconfiguration.openshift.io +| +|Not namespaced +| + +|MachineConfig +|machineconfiguration.openshift.io +| +|Not namespaced +| + +|MachineDeployment +|cluster.k8s.io +| +|Namespaced +| + +|MachineDeployment +|machine.openshift.io +| +|Namespaced +| + +|MachineHealthCheck +|healthchecking.openshift.io +| +|Namespaced +| + +|Machine +|cluster.k8s.io +| +|Namespaced +| + +|Machine +|machine.openshift.io +| +|Namespaced +| + +|MachineSet +|cluster.k8s.io +| +|Namespaced +| + +|MachineSet +|machine.openshift.io +| +|Namespaced +| + +|MCOConfig +|machineconfiguration.openshift.io +| +|Not namespaced +| + +|NetNamespace +|network.openshift.io +| +|Not namespaced +| + +|NetworkAttachmentDefinition +|k8s.cni.cncf.io +| +|Namespaced +| + +|NetworkConfig +|networkoperator.openshift.io +| +|Not namespaced +| + +|Network +|config.openshift.io +| +|Not namespaced +| + +|OAuth +|config.openshift.io +| +|Not namespaced +| + +|OpenShiftAPIServer +|operator.openshift.io +| +|Not namespaced +| + +|OpenShiftControllerManagerOperatorConfig +|openshiftcontrollermanager.operator.openshift.io +| +|Not namespaced +| + +|OperatorGroup +|operators.coreos.com +| +|Namespaced +| + +|OperatorSource +|marketplace.redhat.com +| +|Namespaced +| + +|Project +|config.openshift.io +| +|Not namespaced +| + +|Prometheus +|monitoring.coreos.com +| +|Namespaced +| + +|PrometheusRule +|monitoring.coreos.com +| +|Namespaced +| + +|ServiceCertSignerOperatorConfig +|servicecertsigner.config.openshift.io +| +|Not namespaced +| + +|ServiceMonitor +|monitoring.coreos.com +| +|Namespaced +| + +|Subscription +|operators.coreos.com +| +|Namespaced +| + +|Tuned +|tuned.openshift.io +| +|Namespaced +| +|=== +