<commit_before>include::variables.adoc[]

= Basic Usage
:icons:
:toc: macro
:toc-title:
:toclevels: 2
:imagesdir: images

toc::[]

[[basic-usage-overview]]
== Overview

When you use {project}, you interact with the following components:

- the {project} virtual machine (VM)
- the Docker daemon running on the VM
- the OpenShift cluster running on the Docker daemon

The xref:../using/basic-usage.adoc#diagram-minishift-architecture[{project} architecture] diagram outlines these components.
The `minishift` binary, placed on the `PATH` for easy execution, is used to xref:../using/basic-usage.adoc#minishift-start-overview[`start`], xref:../using/basic-usage.adoc#minishift-stop-overview[`stop`] and xref:../using/basic-usage.adoc#minishift-delete-overview[`delete`] the {project} VM.
The VM itself is bootstrapped off of a xref:../using/choosing-iso-image.adoc#[pluggable, live ISO image].

Some {project} commands, for example xref:../using/docker-daemon.adoc#[`docker-env`], interact with the Docker daemon, whilst others communicate with the OpenShift cluster, for example the xref:../command-ref/minishift_openshift.adoc#[`openshift`] command.

Once the OpenShift cluster is up and running, you interact with it using the `oc` binary.
{project} caches this binary under `$MINISHIFT_HOME` (per default *_~/.minishift_*).
xref:../openshift/openshift-client-binary.adoc#openshift-client-binary-overview[`minishift oc-env`] is an easy way to add the `oc` binary to your `PATH`.

For more details about using {project} to manage your local OpenShift cluster, see the xref:../openshift/index.adoc#[Interacting with OpenShift] section.

[[diagram-minishift-architecture]]
.: Minishift architecture

image::minishift-architecture.png[Minishift architecture]

[[minishift-life-cycle]]
== {project} Life-cycle

[[minishift-start-overview]]
=== {project} start Command

The xref:../command-ref/minishift_start.adoc#[`minishift start`] command creates and configures the {project} VM and provisions a local, single-node OpenShift cluster within the {project} VM.

The command also copies the *oc* binary to your host so that you can interact with OpenShift through the `oc` command line tool or through the Web console, which can be accessed through the URL provided in the output of the `minishift start` command.

[[minishift-stop-overview]]
=== {project} stop Command

The xref:../command-ref/minishift_stop.adoc#[`minishift stop`] command stops your OpenShift cluster and shuts down the {project} VM, but preserves the OpenShift cluster state.

Starting {project} again will restore the OpenShift cluster, allowing you to continue working from the last session.
However, you must enter the same parameters that you used in the original start command.

Efforts to further refine this experience are in progress.
For details, see the GitHub issue link:https://github.com/minishift/minishift/issues/179[#179].

[[minishift-delete-overview]]
=== {project} delete Command

The xref:../command-ref/minishift_delete.adoc#[`minishift delete`] command deletes the OpenShift cluster, and also shuts down and deletes the {project} VM.
No data or state are preserved.

[[runtime-options]]<commit_msg>Issue #3175 - Remove obsolete text in Basic usage guide<commit_after>include::variables.adoc[]

= Basic Usage
:icons:
:toc: macro
:toc-title:
:toclevels: 2
:imagesdir: images

toc::[]

[[basic-usage-overview]]
== Overview

When you use {project}, you interact with the following components:

- the {project} virtual machine (VM)
- the Docker daemon running on the VM
- the OpenShift cluster running on the Docker daemon

The xref:../using/basic-usage.adoc#diagram-minishift-architecture[{project} architecture] diagram outlines these components.
The `minishift` binary, placed on the `PATH` for easy execution, is used to xref:../using/basic-usage.adoc#minishift-start-overview[`start`], xref:../using/basic-usage.adoc#minishift-stop-overview[`stop`] and xref:../using/basic-usage.adoc#minishift-delete-overview[`delete`] the {project} VM.
The VM itself is bootstrapped off of a xref:../using/choosing-iso-image.adoc#[pluggable, live ISO image].

Some {project} commands, for example xref:../using/docker-daemon.adoc#[`docker-env`], interact with the Docker daemon, whilst others communicate with the OpenShift cluster, for example the xref:../command-ref/minishift_openshift.adoc#[`openshift`] command.

Once the OpenShift cluster is up and running, you interact with it using the `oc` binary.
{project} caches this binary under `$MINISHIFT_HOME` (per default *_~/.minishift_*).
xref:../openshift/openshift-client-binary.adoc#openshift-client-binary-overview[`minishift oc-env`] is an easy way to add the `oc` binary to your `PATH`.

For more details about using {project} to manage your local OpenShift cluster, see the xref:../openshift/index.adoc#[Interacting with OpenShift] section.

[[diagram-minishift-architecture]]
.: Minishift architecture

image::minishift-architecture.png[Minishift architecture]

[[minishift-life-cycle]]
== {project} Life-cycle

[[minishift-start-overview]]
=== {project} start Command

The xref:../command-ref/minishift_start.adoc#[`minishift start`] command creates and configures the {project} VM and provisions a local, single-node OpenShift cluster within the {project} VM.

The command also copies the *oc* binary to your host so that you can interact with OpenShift through the `oc` command line tool or through the Web console, which can be accessed through the URL provided in the output of the `minishift start` command.

[[minishift-stop-overview]]
=== {project} stop Command

The xref:../command-ref/minishift_stop.adoc#[`minishift stop`] command stops your OpenShift cluster and shuts down the {project} VM, but preserves the OpenShift cluster state.

Starting {project} again will restore the OpenShift cluster, allowing you to continue working from the last session.
However, you must enter the same parameters that you used in the original start command.

[[minishift-delete-overview]]
=== {project} delete Command

The xref:../command-ref/minishift_delete.adoc#[`minishift delete`] command deletes the OpenShift cluster, and also shuts down and deletes the {project} VM.
No data or state are preserved.

[[runtime-options]]
{'fraction_non_alphanumeric': 0.1100990731863215, 'fraction_numerical': 0.0019175455417066154, 'mean_word_length': 5.2778335005015045, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 1, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '2344497', 'n_tokens_mistral': 1905, 'n_tokens_neox': 1810, 'n_words': 671}