Merge "[doc] Update readme with high level description"

README.md

@@ -1,132 +1,23 @@
-# openstack-controller
+# What is OpenStack Controller
 
-Controller to deploy and manage OpenStack on Kubernetes
+OpenStack Controller is Kubernetes controller that provides Life Cycle Management
+for OpenStack services.
 
-## Prerequisites
+[OpenStack](https://www.openstack.org/) is a free, open standard cloud computing platform.
+It is mostly deployed as infrastructure-as-a-service (IaaS) in both public and private clouds
+where virtual servers and other resources are made available to users. The software platform
+consists of interrelated components that control diverse, multi-vendor hardware pools of
+processing, storage, and networking resources throughout a data center. Users manage it either
+through a web-based dashboard, through command-line tools, or through RESTful web services.
 
-Working kubernetes cluster with multiple computes where node labeling is done according to theirs roles.
+OpenStack Controller automates deployment and management of OpenStack to provide self-managing,
+self-scaling and self-healing services.
 
-For openstack we will require the following labels:
+# Getting Started and Documentation
 
- * `openstack-control-plane=enabled` - for k8s computes that will host openstack control plane containers
- * `openstack-compute-node=enabled` - for k8s computes that will host openstack compute nodes
- * `openvswitch=enabled` - for k8s computes that will host openstack network gateway services and compute nodes
+For installation, deployment, and administration, see our [Documentation](https://mirantis.github.io/openstack-controller/)
+and [Quick start guide](https://mirantis.github.io/openstack-controller/quick-start/aio-installation/)
 
-For ceph we will require the following labels:
+# Report a Bug
 
- * `role=ceph-osd-node` - for k8s computes that will host ceph osd's
-
-Apply all the required labels to all the nodes except of master k8s node
-(**only for dev envs!**):
-```
-kubectl label node -l node-role.kubernetes.io/master!= openstack-control-plane=enabled openstack-compute-node=enabled openvswitch=enabled role=ceph-osd-node
-```
-
-## Usage
-
-### Download release-openstack-k8s repo
-```
-git clone "https://gerrit.mcp.mirantis.com/mcp/release-openstack-k8s"
-cd release-openstack-k8s
-git tag -n
-git checkout 0.3.0
-```
-
-### Deploy infra parts
-
-These include required CRDs and controllers for Helm, Ceph and OpenStack.
-
-Create resources one by one with small delay to ensure kopfpeering is created by ceph.
-```
-    for d in release 3rd-party ci; do
-      pushd release
-      for i in $(ls -1 ./*); do
-        kubectl apply -f $i
-        sleep 10
-      done
-      popd
-    done
-```
-
-### Deploy ceph cluster
-1. Update node names in examples/miraceph/ceph_local_folder_openstack.yaml
-2. Deploy Ceph cluster
-```
-kubectl apply -f examples/miraceph/ceph_local_folder_openstack.yaml
-```
-
-### Deploy OpenStack
-
-#### Update DNS
-
-to match currently configured in the Kubernetes cluster
-
-```
-sed -i "s/kaas-kubernetes-3af5ae538cf411e9a6c7fa163e5a4837/$(kubectl get configmap -n kube-system coredns -o jsonpath='{.data.Corefile}' |grep -oh kaas-kubernetes-[[:alnum:]]*)/g" examples/osdpl/core-ceph-local-non-dvr.yaml
-```
-
-#### Generate Certs for public endpoints
-
-Generate certs with correct domain
-```
-relase_repo_path=~/release-openstack-k8s
-pushd openstack-controller/tools/ssl
-  bash/makecerts.sh $relase_repo_path/examples/osdpl/core-ceph-local-non-dvr.yaml
-popd
-```
-
-#### Create OpenStackDeployment
-```
-relase_repo_path=~/release-openstack-k8s
-kubectl apply -f $relase_repo_path/examples/osdpl/core-ceph-local-non-dvr.yaml
-```
-
-## Validate OpenStack
-
-Access the keystone-client pod
-```
-kubectl -n openstack get pods -l application=keystone,compoment=client
-# example output
-# NAME                               READY   STATUS    RESTARTS   AGE
-# keystone-client-84d5f99754-7tdz6   1/1     Running   0          14d
-
-kubectl -n openstack exec -it keystone-client-84d5f99754-7tdz6 -- bash
-```
-
-Inside the pod you have openstack client with mounted keystone admin credentials,
-so for example you can do:
-```
-wget https://binary.mirantis.com/openstack/bin/cirros/0.5.1/cirros-0.5.1-x86_64-disk.img
-openstack image create cirros-0.5.1-x86_64-disk --file cirros-0.5.1-x86_64-disk.img --disk-format qcow2 --container-format bare --public
-openstack network create demoNetwork
-openstack subnet create demoSubnet --network demoNetwork --subnet-range 10.11.12.0/24
-openstack server create --image cirros-0.5.1-x86_64-disk --flavor m1.tiny --nic net-id=demoNetwork DemoVM
-```
-
-## Advanced Usage
-
-### Connect to helm directly
-
-```
-# Download helm client with your version:
-wget https://get.helm.sh/helm-v3.7.1-linux-amd64.tar.gz
-tar -xf helm-v3.7.1-linux-amd64.tar.gz
-mv linux-amd64/helm /usr/local/bin/helm
-
-# Use helm as always :)
-helm list
-```
-
-# Admission Controller for Kubernetes OpenStackDeployment
-
-You can read more about admission controllers [here](https://kubernetes.io/docs/reference/access-authn-authz/admission-controllers).
-To use this particular admission controller, you need to have
-ValidatingAdmissionWebhook admission plugin enabled in Kubernetes API server.
-
-Should be run under uwsgi, for example:
-
-`$ uwsgi uwsgi.ini`
-
-As the service runs under HTTPS, you need to also provide server certificate
-and key (named oac.crt and oac.key) by default. They can be generated for
-example by using [this script](https://github.com/alex-leonhardt/k8s-mutate-webhook/blob/master/ssl/ssl.sh).
+For filing bugs, suggesting improvements, or requesting new features, please open an [issue](https://github.com/Mirantis/openstack-controller/issues).

docs/developer.md

@@ -0,0 +1,24 @@
+# Developer Guide
+
+## Code Style
+
+OpenStack Contoller uses [Black](https://black.readthedocs.io/en/stable/) code formatter
+To check your chenages and format them use
+```bash
+tox -e black
+```
+
+## Tests
+
+Each commit should require to pass code styles and unittests. To run unittests locally
+```bash
+tox -e py310
+```
+
+## Running controller locally
+
+OpenStack Controller is deployed as helm chart into kubernetes cluster. However there is
+possibility to run controller locally. For this:
+```bash
+tox -e dev
+```

docs/index.md

@@ -15,7 +15,7 @@ and then reacts to these changes by creating, updating, or deleting appropriate
 
 * File a bug: [https://github.com/Mirantis/openstack-controller/issues](https://github.com/Mirantis/openstack-controller/issues)
 
-## Developer: 
+## Developer
 
 * Contributing: [https://TODO]()
-* Reference Architecture:  [https://TODO]()
+* Reference Architecture:  [https://mirantis.github.io/openstack-controller](https://mirantis.github.io/openstack-controller)

mkdocs.yml

@@ -82,6 +82,7 @@ nav:
   - Quick Start:
     - AIO Installation: quick-start/aio-installation.md
     - Access OpenStack: quick-start/access-openstack.md
+  - Developer Guide: developer.md
   - Operations Guide:
     - Upgrade OpenStack: ops/openstack/upgrade.md
     - Run tempest: ops/openstack/tempest.md