From 19a5651eccd92702ad77729c1a4dbd33e3d97227 Mon Sep 17 00:00:00 2001 From: "Frank A. Zdarsky" Date: Mon, 25 Oct 2021 23:39:56 +0200 Subject: [PATCH] Consistently spell MicroShift Signed-off-by: Frank A. Zdarsky --- CONTRIBUTING.md | 14 +++++----- README.md | 40 +++++++++++++------------- cmd/microshift/main.go | 2 +- docs/_config.yaml | 4 +-- docs/index.md | 42 ++++++++++++++-------------- docs/microshift-aio/README.md | 4 +-- hack/all-in-one/README.md | 6 ++-- install.sh | 4 +-- packaging/images/microshift-aio/unit | 2 +- packaging/rpm/microshift.spec | 14 +++++----- packaging/systemd/microshift.service | 2 +- pkg/cmd/run.go | 8 +++--- pkg/cmd/version.go | 4 +-- 13 files changed, 73 insertions(+), 73 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5938a21fe8..63d21c91b6 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,9 +1,9 @@ -# Contributing to Microshift +# Contributing to MicroShift -If you would like to develop Microshift locally, you can follow this guide on getting +If you would like to develop MicroShift locally, you can follow this guide on getting it installed and running through the provided Makefile. -This guide will primarily focus on running Microshift within a VM using Vagrant. +This guide will primarily focus on running MicroShift within a VM using Vagrant. ## (optional) Developing with Vagrant @@ -18,7 +18,7 @@ system of your choice. For this example we will be looking at a [fedora 34 cloud image](https://app.vagrantup.com/fedora/boxes/34-cloud-base), however you can substitute any vagrant image of your choice. -First, navigate to the Microshift directory on your host system, or another designated +First, navigate to the MicroShift directory on your host system, or another designated directory where we will be storing the Vagrantfile. @@ -138,7 +138,7 @@ and click on the button to connect to it in a remote window. ](https://medium.com/@lopezgand/connect-visual-studio-code-with-vagrant-in-your-local-machine-24903fb4a9de))* -## Running Microshift Locally +## Running MicroShift Locally ### Pre-Installation @@ -175,9 +175,9 @@ git clone https://github.com/redhat-et/microshift.git cd microshift ``` -### Building Microshift +### Building MicroShift -Now we can build Microshift: +Now we can build MicroShift: ```sh make build diff --git a/README.md b/README.md index b88a7c338c..67b315ed1c 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,8 @@ -# Microshift +# MicroShift -Microshift is a research project that is exploring how OpenShift1 Kubernetes can be optimized for small form factor and edge computing. +MicroShift is a research project that is exploring how OpenShift1 Kubernetes can be optimized for small form factor and edge computing. -Edge devices deployed out in the field pose very different operational, environmental, and business challenges from those of cloud computing. These motivate different engineering trade-offs for Kubernetes at the far edge than for cloud or near-edge scenarios. Microshift's design goals cater to this: +Edge devices deployed out in the field pose very different operational, environmental, and business challenges from those of cloud computing. These motivate different engineering trade-offs for Kubernetes at the far edge than for cloud or near-edge scenarios. MicroShift's design goals cater to this: - make frugal use of system resources (CPU, memory, network, storage, etc.), - tolerate severe networking constraints, @@ -10,21 +10,21 @@ Edge devices deployed out in the field pose very different operational, environm - build on and integrate cleanly with edge-optimized OSes like Fedora IoT and RHEL for Edge, while - providing a consistent development and management experience with standard OpenShift. -We believe these properties should also make Microshift a great tool for other use cases such as Kubernetes applications development on resource-constrained systems, scale testing, and provisioning of lightweight Kubernetes control planes. +We believe these properties should also make MicroShift a great tool for other use cases such as Kubernetes applications development on resource-constrained systems, scale testing, and provisioning of lightweight Kubernetes control planes. Watch this [end-to-end MicroShift provisioning demo video](https://youtu.be/QOiB8NExtA4) to get a first impression of MicroShift deployed onto a [RHEL for edge computing](https://www.redhat.com/en/technologies/linux-platforms/enterprise-linux/edge-computing) device and managed through [Open Cluster Management](https://github.com/open-cluster-management). -**Note: Microshift is still early days and moving fast. Features are missing. Things break. But you can still help shape it, too.** +**Note: MicroShift is still early days and moving fast. Features are missing. Things break. But you can still help shape it, too.** 1) more precisely [OKD](https://www.okd.io/), the Kubernetes distribution by the OpenShift community ## Minimum specs -In order to run Microshift, you will need at least: +In order to run MicroShift, you will need at least: - 2 CPU cores - 2GB of RAM -- ~124MB of free storage space for the Microshift binary +- ~124MB of free storage space for the MicroShift binary - 64-bit CPU (although 32-bit is _technically_ possible, if you're up for the challenge) For barebones development the minimum requirement is 3GB of RAM, though this can increase @@ -32,9 +32,9 @@ if you are using resource-intensive devtools. ### OS Requirements -The all-in-one containerized Microshift can run on Windows, MacOS, and Linux. +The all-in-one containerized MicroShift can run on Windows, MacOS, and Linux. -Currently, the Microshift binary is known to be supported on the following Operating Systems: +Currently, the MicroShift binary is known to be supported on the following Operating Systems: - Fedora 33/34 - CentOS 8 Stream @@ -42,17 +42,17 @@ Currently, the Microshift binary is known to be supported on the following Opera - CentOS 7 - Ubuntu 20.04 -It may be possible to run Microshift on other systems, however they haven't been tested so you may run into issues. +It may be possible to run MicroShift on other systems, however they haven't been tested so you may run into issues. -## Using Microshift +## Using MicroShift -To give Microshift a try, simply install a recent test version (we don't provide stable releases yet) on a Fedora-derived Linux distro (we've only tested Fedora, RHEL, and CentOS Stream so far) using: +To give MicroShift a try, simply install a recent test version (we don't provide stable releases yet) on a Fedora-derived Linux distro (we've only tested Fedora, RHEL, and CentOS Stream so far) using: ```sh curl -sfL https://raw.githubusercontent.com/redhat-et/microshift/main/install.sh | bash ``` -This will install Microshift's dependencies (CRI-O), install it as a systemd service and start it. +This will install MicroShift's dependencies (CRI-O), install it as a systemd service and start it. For convenience, the script will also add a new "microshift" context to your `$HOME/.kube/config`, so you'll be able to access your cluster using, e.g.: @@ -67,7 +67,7 @@ kubectl config use-context microshift kubectl get all -A ``` -Notes: When installing Microshift on a system with an older version already installed, it is safest to remove the old data directory and start fresh: +Notes: When installing MicroShift on a system with an older version already installed, it is safest to remove the old data directory and start fresh: ```sh rm -rf /var/lib/microshift && rm -r $HOME/.microshift @@ -75,13 +75,13 @@ rm -rf /var/lib/microshift && rm -r $HOME/.microshift ## [Known Issues](./docs/known-issues.md) -## Developing Microshift +## Developing MicroShift > Note: when building or running **ARM64** container images, Linux host environments must have the `qemu-user-static` package installed. E.g. on Fedora: `dnf install qemu-user-static`. ### Building -You can locally build Microshift using one of two methods, either using a container build (recommended) on Podman or Docker: +You can locally build MicroShift using one of two methods, either using a container build (recommended) on Podman or Docker: ```sh sudo yum -y install make golang @@ -104,21 +104,21 @@ make ### Environment Configuration -Before running Microshift, the host must first be configured. This can be handled by running +Before running MicroShift, the host must first be configured. This can be handled by running ``` CONFIG_ENV_ONLY=true ./install.sh ``` -Microshift keeps all its state in its data-dir, which defaults to `/var/lib/microshift` when running Microshift as privileged user and `$HOME/.microshift` otherwise. Note that running Microshift unprivileged only works without node role at the moment (i.e. using `--roles=controlplane` instead of the default of `--roles=controlplane,node`). +MicroShift keeps all its state in its data-dir, which defaults to `/var/lib/microshift` when running MicroShift as privileged user and `$HOME/.microshift` otherwise. Note that running MicroShift unprivileged only works without node role at the moment (i.e. using `--roles=controlplane` instead of the default of `--roles=controlplane,node`). ### Kubeconfig -When starting the Microshift for the first time the Kubeconfig file is created. If you need it for another user or to use externally the kubeadmin's kubeconfig is placed at `/var/lib/microshift/resources/kubeadmin/kubeconfig`. +When starting the MicroShift for the first time the Kubeconfig file is created. If you need it for another user or to use externally the kubeadmin's kubeconfig is placed at `/var/lib/microshift/resources/kubeadmin/kubeconfig`. ### Contributing -For more information on working with Microshift, you can find a contributor's guide in [CONTRIBUTING.md](./CONTRIBUTING.md) +For more information on working with MicroShift, you can find a contributor's guide in [CONTRIBUTING.md](./CONTRIBUTING.md) ### Community diff --git a/cmd/microshift/main.go b/cmd/microshift/main.go index aa84a9f7dc..f01aeceddc 100644 --- a/cmd/microshift/main.go +++ b/cmd/microshift/main.go @@ -38,7 +38,7 @@ func main() { func newCommand() *cobra.Command { cmd := &cobra.Command{ Use: "microshift", - Short: "Microshift, a minimal OpenShift", + Short: "MicroShift, a minimal OpenShift", Run: func(cmd *cobra.Command, args []string) { cmd.Help() os.Exit(1) diff --git a/docs/_config.yaml b/docs/_config.yaml index 0f811d7539..b6841b2ed3 100644 --- a/docs/_config.yaml +++ b/docs/_config.yaml @@ -2,8 +2,8 @@ domain: microshift.io # if you want to force HTTPS, specify the domain without the http at the start, e.g. example.com url: https://microshift.io # the base hostname and protocol for your site, e.g. http://example.com -title: Microshift -description: Microshift is a research project that is exploring how OpenShift Kubernetes can be optimized for small form factor and edge computing. +title: MicroShift +description: MicroShift is a research project that is exploring how OpenShift Kubernetes can be optimized for small form factor and edge computing. type: website keep_files: ["CNAME"] repository: redhat-et/microshift diff --git a/docs/index.md b/docs/index.md index abc25ea283..79ef6a5551 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,14 +1,14 @@ --- modified: "2021-10-25T11:08:42.763+02:00" -title: The Project -tags: microsihift project, edge, µShift +title: The Project +tags: microshift project, edge, µShift layout: page toc: true --- -Microshift is a research project that is exploring how OpenShift1 Kubernetes can be optimized for small form factor and edge computing. +MicroShift is a research project that is exploring how OpenShift1 Kubernetes can be optimized for small form factor and edge computing. -Edge devices deployed out in the field pose very different operational, environmental, and business challenges from those of cloud computing. These motivate different engineering trade-offs for Kubernetes at the far edge than for cloud or near-edge scenarios. Microshift's design goals cater to this: +Edge devices deployed out in the field pose very different operational, environmental, and business challenges from those of cloud computing. These motivate different engineering trade-offs for Kubernetes at the far edge than for cloud or near-edge scenarios. MicroShift's design goals cater to this: - make frugal use of system resources (CPU, memory, network, storage, etc.), - tolerate severe networking constraints, @@ -16,22 +16,22 @@ Edge devices deployed out in the field pose very different operational, environm - build on and integrate cleanly with edge-optimized OSes like Fedora IoT and RHEL for Edge, while - providing a consistent development and management experience with standard OpenShift. -We believe these properties should also make Microshift a great tool for other use cases such as Kubernetes applications development on resource-constrained systems, scale testing, and provisioning of lightweight Kubernetes control planes. +We believe these properties should also make MicroShift a great tool for other use cases such as Kubernetes applications development on resource-constrained systems, scale testing, and provisioning of lightweight Kubernetes control planes. Watch this [end-to-end MicroShift provisioning demo video](https://youtu.be/QOiB8NExtA4) to get a first impression of MicroShift deployed onto a [RHEL for edge computing](https://www.redhat.com/en/technologies/linux-platforms/enterprise-linux/edge-computing) device and managed through [Open Cluster Management](https://github.com/open-cluster-management). > warning "" -> Microshift is still early days and moving fast. Features are missing. Things break. But you can still help shape it, too.\*\* +> MicroShift is still early days and moving fast. Features are missing. Things break. But you can still help shape it, too.\*\* 1) more precisely [OKD](https://www.okd.io/), the Kubernetes distribution by the OpenShift community ## Minimum specs -In order to run Microshift, you will need at least: +In order to run MicroShift, you will need at least: - 2 CPU cores - 2GB of RAM -- ~124MB of free storage space for the Microshift binary +- ~124MB of free storage space for the MicroShift binary - 64-bit CPU (although 32-bit is _technically_ possible, if you're up for the challenge) For barebones development the minimum requirement is 3GB of RAM, though this can increase @@ -39,9 +39,9 @@ if you are using resource-intensive devtools. ### OS Requirements -The all-in-one containerized Microshift can run on Windows, MacOS, and Linux. +The all-in-one containerized MicroShift can run on Windows, MacOS, and Linux. -Currently, the Microshift binary is known to be supported on the following Operating Systems: +Currently, the MicroShift binary is known to be supported on the following Operating Systems: - Fedora 33/34 - CentOS 8 Stream @@ -49,17 +49,17 @@ Currently, the Microshift binary is known to be supported on the following Opera - CentOS 7 - Ubuntu 20.04 -It may be possible to run Microshift on other systems, however they haven't been tested so you may run into issues. +It may be possible to run MicroShift on other systems, however they haven't been tested so you may run into issues. -## Using Microshift +## Using MicroShift -To give Microshift a try, simply install a recent test version (we don't provide stable releases yet) on a Fedora-derived Linux distro (we've only tested Fedora, RHEL, and CentOS Stream so far) using: +To give MicroShift a try, simply install a recent test version (we don't provide stable releases yet) on a Fedora-derived Linux distro (we've only tested Fedora, RHEL, and CentOS Stream so far) using: ```sh curl -sfL https://raw.githubusercontent.com/redhat-et/microshift/main/install.sh | bash ``` -This will install Microshift's dependencies (CRI-O), install it as a systemd service and start it. +This will install MicroShift's dependencies (CRI-O), install it as a systemd service and start it. For convenience, the script will also add a new "microshift" context to your `$HOME/.kube/config`, so you'll be able to access your cluster using, e.g.: @@ -75,7 +75,7 @@ kubectl get all -A ``` > info "" -> When installing Microshift on a system with an older version already installed, it is safest to remove the old data directory and start fresh: +> When installing MicroShift on a system with an older version already installed, it is safest to remove the old data directory and start fresh: ```sh rm -rf /var/lib/microshift && rm -r $HOME/.microshift @@ -83,14 +83,14 @@ rm -rf /var/lib/microshift && rm -r $HOME/.microshift ## [Known Issues](./known-issues.md) -## Developing Microshift +## Developing MicroShift > warning "" > when building or running **ARM64** container images, Linux host environments must have the `qemu-user-static` package installed. E.g. on Fedora: `dnf install qemu-user-static`. ### Building -You can locally build Microshift using one of two methods, either using a container build (recommended) on Podman or Docker: +You can locally build MicroShift using one of two methods, either using a container build (recommended) on Podman or Docker: ```sh sudo yum -y install make golang @@ -113,21 +113,21 @@ make ### Environment Configuration -Before running Microshift, the host must first be configured. This can be handled by running +Before running MicroShift, the host must first be configured. This can be handled by running ```sh CONFIG_ENV_ONLY=true ./install.sh ``` -Microshift keeps all its state in its data-dir, which defaults to `/var/lib/microshift` when running Microshift as privileged user and `$HOME/.microshift` otherwise. Note that running Microshift unprivileged only works without node role at the moment (i.e. using `--roles=controlplane` instead of the default of `--roles=controlplane,node`). +MicroShift keeps all its state in its data-dir, which defaults to `/var/lib/microshift` when running MicroShift as privileged user and `$HOME/.microshift` otherwise. Note that running MicroShift unprivileged only works without node role at the moment (i.e. using `--roles=controlplane` instead of the default of `--roles=controlplane,node`). ### Kubeconfig -When starting the Microshift for the first time the Kubeconfig file is created. If you need it for another user or to use externally the kubeadmin's kubeconfig is placed at `/var/lib/microshift/resources/kubeadmin/kubeconfig`. +When starting the MicroShift for the first time the Kubeconfig file is created. If you need it for another user or to use externally the kubeadmin's kubeconfig is placed at `/var/lib/microshift/resources/kubeadmin/kubeconfig`. ### Contributing -For more information on working with Microshift, you can find a contributor's guide in [CONTRIBUTING.md](./CONTRIBUTING.md) +For more information on working with MicroShift, you can find a contributor's guide in [CONTRIBUTING.md](./CONTRIBUTING.md) ### Community diff --git a/docs/microshift-aio/README.md b/docs/microshift-aio/README.md index ef1da3b870..3fc7f959c8 100644 --- a/docs/microshift-aio/README.md +++ b/docs/microshift-aio/README.md @@ -6,7 +6,7 @@ tags: all-in-one, aio toc: true --- -## Run Microshift All-In-One as a Systemd Service +## Run MicroShift All-In-One as a Systemd Service Copy `microshift-aio` unit file to `/etc/systemd` and the aio run script to `/usr/bin` @@ -130,4 +130,4 @@ make microshfit-aio ## Limitation These instructions are tested on Linux, Mac, and Windows. -On MacOS, running containerized Microshift as non-root is not supported on MacOS. +On MacOS, running containerized MicroShift as non-root is not supported on MacOS. diff --git a/hack/all-in-one/README.md b/hack/all-in-one/README.md index ef9f0bc084..96118f3095 100644 --- a/hack/all-in-one/README.md +++ b/hack/all-in-one/README.md @@ -1,6 +1,6 @@ -# Containerized Microshift With GPU Support and Kubectl +# Containerized MicroShift With GPU Support and Kubectl -## Run Microshift All-In-One as a Systemd Service +## Run MicroShift All-In-One as a Systemd Service Copy microshift-aio unit file to /etc/systemd and the aio run script to /usr/bin @@ -109,4 +109,4 @@ TAG="quay.io/myname/myrepo:dev" ./hack/build-aio-dev.sh ## Limitation These instructions are tested on Linux, Mac, and Windows. -On MacOS, running containerized Microshift as non-root is not supported on MacOS. +On MacOS, running containerized MicroShift as non-root is not supported on MacOS. diff --git a/install.sh b/install.sh index 5cb5239895..8b22928f1f 100755 --- a/install.sh +++ b/install.sh @@ -137,7 +137,7 @@ install_crio() { } -# CRI-O config to match Microshift networking values +# CRI-O config to match MicroShift networking values crio_conf() { sudo sh -c 'cat << EOF > /etc/cni/net.d/100-crio-bridge.conf { @@ -195,7 +195,7 @@ get_microshift() { cat << EOF | sudo tee /usr/lib/systemd/system/microshift.service [Unit] -Description=Microshift +Description=MicroShift After=crio.service [Service] diff --git a/packaging/images/microshift-aio/unit b/packaging/images/microshift-aio/unit index 1ae6c85efe..594883ee40 100644 --- a/packaging/images/microshift-aio/unit +++ b/packaging/images/microshift-aio/unit @@ -1,5 +1,5 @@ [Unit] -Description=Microshift +Description=MicroShift After=crio.service [Service] diff --git a/packaging/rpm/microshift.spec b/packaging/rpm/microshift.spec index 9da0353c09..a5675bd462 100644 --- a/packaging/rpm/microshift.spec +++ b/packaging/rpm/microshift.spec @@ -22,7 +22,7 @@ Name: microshift Version: %{version} Release: %{release}%{dist} # this can be %{timestamp}.git%{short_hash} later for continous main builds -Summary: Microshift binary +Summary: MicroShift binary License: ASL 2.0 URL: https://github.com/redhat-et/microshift @@ -55,14 +55,14 @@ Requires: microshift-selinux %{?systemd_requires} %description -Microshift is a research project that is exploring how OpenShift Kubernetes +MicroShift is a research project that is exploring how OpenShift Kubernetes can be optimized for small form factor and edge computing. Edge devices deployed out in the field pose very different operational, environmental, and business challenges from those of cloud computing. These motivate different engineering trade-offs for Kubernetes at the far edge than for cloud or near-edge -scenarios. Microshift's design goals cater to this: +scenarios. MicroShift's design goals cater to this: make frugal use of system resources (CPU, memory, network, storage, etc.), tolerate severe networking constraints, update (resp. roll back) securely, @@ -71,22 +71,22 @@ and integrate cleanly with edge-optimized OSes like Fedora IoT and RHEL for Edge while providing a consistent development and management experience with standard OpenShift. -We believe these properties should also make Microshift a great tool for other +We believe these properties should also make MicroShift a great tool for other use cases such as Kubernetes applications development on resource-constrained systems, scale testing, and provisioning of lightweight Kubernetes control planes. -Note: Microshift is still early days and moving fast. Features are missing. +Note: MicroShift is still early days and moving fast. Features are missing. Things break. But you can still help shape it, too. %package selinux -Summary: SELinux policies for Microshift +Summary: SELinux policies for MicroShift BuildRequires: selinux-policy BuildRequires: selinux-policy-devel BuildArch: noarch %{?selinux_requires} %description selinux -SElinux policy modules for Microshift. +SElinux policy modules for MicroShift. %prep diff --git a/packaging/systemd/microshift.service b/packaging/systemd/microshift.service index 0425b12b09..0a779675c0 100644 --- a/packaging/systemd/microshift.service +++ b/packaging/systemd/microshift.service @@ -1,5 +1,5 @@ [Unit] -Description=Microshift +Description=MicroShift After=crio.service [Service] diff --git a/pkg/cmd/run.go b/pkg/cmd/run.go index 1bc50d53c6..c90003b481 100644 --- a/pkg/cmd/run.go +++ b/pkg/cmd/run.go @@ -31,7 +31,7 @@ func NewRunMicroshiftCommand() *cobra.Command { cmd := &cobra.Command{ Use: "run", - Short: "Run Microshift", + Short: "Run MicroShift", RunE: func(cmd *cobra.Command, args []string) error { return RunMicroshift(cfg, cmd.Flags()) }, @@ -43,7 +43,7 @@ func NewRunMicroshiftCommand() *cobra.Command { cmd.MarkFlagFilename("config", "yaml", "yml") // All other flags will be read after reading both config file and env vars. flags.String("data-dir", cfg.DataDir, "Directory for storing runtime data.") - flags.StringSlice("roles", cfg.Roles, "Roles of this Microshift instance.") + flags.StringSlice("roles", cfg.Roles, "Roles of this MicroShift instance.") return cmd } @@ -55,7 +55,7 @@ func RunMicroshift(cfg *config.MicroshiftConfig, flags *pflag.FlagSet) error { // fail early if we don't have enough privileges if config.StringInList("node", cfg.Roles) && os.Geteuid() > 0 { - logrus.Fatalf("Microshift must be run privileged for role 'node'") + logrus.Fatalf("MicroShift must be run privileged for role 'node'") } os.MkdirAll(cfg.DataDir, 0700) @@ -98,7 +98,7 @@ func RunMicroshift(cfg *config.MicroshiftConfig, flags *pflag.FlagSet) error { util.Must(m.AddService(node.NewKubeProxyServer(cfg))) } - logrus.Info("Starting Microshift") + logrus.Info("Starting MicroShift") ctx, cancel := context.WithCancel(context.Background()) ready, stopped := make(chan struct{}), make(chan struct{}) diff --git a/pkg/cmd/version.go b/pkg/cmd/version.go index 5c068b1fac..c83dfa936d 100644 --- a/pkg/cmd/version.go +++ b/pkg/cmd/version.go @@ -29,7 +29,7 @@ func NewVersionCommand(ioStreams genericclioptions.IOStreams) *cobra.Command { o := NewVersionOptions(ioStreams) cmd := &cobra.Command{ Use: "version", - Short: "Print Microshift version information", + Short: "Print MicroShift version information", Run: func(cmd *cobra.Command, args []string) { // cmdutil.CheckErr(o.Validate()) // cmdutil.CheckErr(o.Complete(f, cmd)) @@ -47,7 +47,7 @@ func (o *VersionOptions) Run() error { switch o.Output { case "": - fmt.Fprintf(o.Out, "Microshift Version: %s\n", versionInfo.String()) + fmt.Fprintf(o.Out, "MicroShift Version: %s\n", versionInfo.String()) fmt.Fprintf(o.Out, "Base OKD Version: %s\n", release.Base) case "yaml": marshalled, err := yaml.Marshal(&versionInfo)