@@ -18,16 +18,20 @@ Before installing, you need to:
1818
1919- install [ ops] ( /docs/installation/download/ ) .
2020
21- - perform a minimal configuration. For more details about this,
22- check [ Configure the services] ( /docs/installation/configure/ ) .
21+ Furthermore you will need a decent PC / Mac.
22+
23+ Docker will need 4 Gb Ram and almost 40Gb of free space to run the cluster
24+ locally.
2325
2426{{< blockquote info >}}
25- The static service works perfectly for the default namespace nuvolaris which is linking the http://localhost to the
26- nuvolaris web bucket. With this setup adding new users will add an ingress with host set to
27- namespace.localhost, that in theory could also work if the host file of the development machine is configured
28- to resolve it to the 127.0.0.1 ip address.
29- {{< /blockquote >}}
27+ We introduced a special domain called ` miniops.me ` : this domain will always
28+ resolve to 127.0.0.1.
29+ This way the static service for the default namespace nuvolaris will be
30+ linking the ` http://miniops.me ` to the nuvolaris web bucket.
31+ Adding new users will add an ingress with host set to
32+ ` http://<namespace>.miniops.me ` .
3033
34+ {{< /blockquote >}}
3135
3236{{< blockquote warning >}}
3337You cannot have `` https `` in a local installation.
@@ -36,64 +40,60 @@ If you enable it, the configuration will be ignored.
3640
3741### Installation
3842
39- Run the commands:
40-
41- 1 . Minimal configuration
43+ The following command will perform a full local installation:
4244
4345``` bash
44- ops config minimal
46+ ops setup mini
4547```
4648
47- Behind the scene, this command will write a cluster configuration file called ` ~/.ops/config.json ` activating these
48- services: ` static ` , ` redis ` , ` postgres ` , ` ferretdb ` , ` minio ` , ` cron ` constituting the common baseline for development
49- tasks.
49+ Behind the scene, this command will write a cluster configuration file called
50+ ` ~/.ops/config.json ` activating these services: ` static ` , ` redis ` , ` postgres ` ,
51+ ` ferretdb ` , ` minio ` , ` cron ` , ` milvus ` constituting the common baseline for
52+ development tasks.
53+
54+ Wait until the command terminates. It will take minutes to complete, so be
55+ patient.
5056
51- 2 . Setup the cluster
57+ The installation will ends showing these informations:
5258
5359``` bash
54- ops setup devcluster
60+ *** Configuring Access to OpenServerless ***
61+ apihost=http://miniops.me username=devel
62+ Logging in http://miniops.me as devel
63+ Successfully logged in as devel.
64+ ok: whisk auth set. Run ' wsk property get --auth'
65+ ok: whisk API host set to http://miniops.me
66+ OpenServerless host and auth set successfully. You are now ready to use ops!
67+ ==================| UPLOAD RESULTS | ==================
68+ | FILES : 4
69+ | COMPLETED : 4
70+ | ERRORS : 0
71+ | SKIPPED : 0
72+ | EXEC. TIME : 46.70 ms
73+ ======================================================
74+ Login with: ops ide login devel https://miniops.me
75+ Password is saved in: /Users/openserverless/.ops/devel.password
76+ Web URL is: http://devel.miniops.me
5577```
5678
57- and wait until the command terminates.
79+ ### Try your devel user
5880
59- {{< details title="Click here to see a log sample of the setup">}}
81+ At the end of the setup, you'll have a local OpenServerless installation
82+ with a ` devel ` user.
6083
61- ``` bash
62- ops setup devcluster
63- Creating cluster " nuvolaris"
64- ✓ Ensuring node image (kindest/node:v1.25.3) 🖼
65- ✓ Preparing nodes 📦 📦
66- ✓ Writing configuration 📜
67- ✓ Starting control-plane 🕹️
68- ✓ Installing CNI 🔌
69- ✓ Installing StorageClass 💾
70- ✓ Joining worker nodes 🚜
71- ✓ Waiting ≤ 1m0s for control-plane = Ready ⏳
72- • Ready after 1s 💚
73- Set kubectl context to " kind-nuvolaris"
74- You can now use your cluster with:
75-
76- kubectl cluster-info --context kind-nuvolaris --kubeconfig /Users/bruno/.ops/tmp/kubeconfig
77-
78- Thanks for using kind!
79-
80- [...continue]
81- ```
84+ Open a browser to http://devel.miniops.me . You will see a page like this:
8285
83- > 💡 ** NOTE**
84- >
85- > The log will continue because, after kind is up and running, OpenServerless namespace and relative services are
86- > installed inside.
86+ <img src =" /welcome-mini.webp " width =" 700 " alt =" Welcome Mini " />
8787
88- It will take some minute to complete, so be patient.
89-
90- {{< /details >}}
88+ Take a minute to share on Linkedin your experience with the setup and to join
89+ us on [ Discord] ( https://discord.com/invite/PkD7CcHgGP ) .
9190
9291### Troubleshooting
9392
9493Usually the setup completes without errors.
9594
96- However, if ` ops ` is unable to complete the setup, you may see this message at the end:
95+ However, if ` ops ` is unable to complete the setup, you may see this message at
96+ the end:
9797
9898``` text
9999ops: Failed to run task "create": exit status 1
@@ -105,10 +105,8 @@ task execution error: ops: Failed to run task "devcluster": exit status 1
105105If this is your case, try to perform a uninstall / reinstall:
106106
107107``` bash
108- ops setup cluster --uninstall
108+ ops setup devcluster --uninstall
109109ops config reset
110- ops config minimal
111- ops setup devcluster
112110```
113111
114112If this will not solve, please contact the community.
@@ -117,24 +115,13 @@ If this will not solve, please contact the community.
117115
118116[ Check the tutorial] ( /docs/tutorial/ ) to learn how to use it.
119117
120- ### Uninstall
121118
122- To uninstall you may:
123-
124- #### Uninstall devcluster
119+ ### Uninstall and remove devcluster
125120
126121This will actually remove the ops namespace and all the services from kind.
127122Useful to re-try an installation when something gone wrong.
128123
129- ``` bash
130- ops setup cluster --uninstall
131- ops config reset
132- ```
133-
134- #### Remove devcluster
135-
136- This will actually remove the nodes from kind:
137-
138124``` bash
139125ops setup devcluster --uninstall
126+ ops config reset
140127```
0 commit comments