alter readme
This commit is contained in:
@@ -4,6 +4,9 @@ Only tested on Ubuntu-24.04 wsl
|
||||
## Quick Start
|
||||
|
||||
```bash
|
||||
# Please install golang v1.22 or greater before starting
|
||||
sudo apt install golang
|
||||
|
||||
# Option 1: Using CLI tool (recommended)
|
||||
./cli/build.sh # build CLI tool in project
|
||||
./provision-cli provision # Run interactive provisioning in project root
|
||||
@@ -29,9 +32,12 @@ This project provides tools to create and manage local Kubernetes development en
|
||||
- [Ansible](https://docs.ansible.com/ansible/latest/installation_guide/index.html) - for configuration
|
||||
- SSH tools (OpenSSH client)
|
||||
- Python 3
|
||||
- Golang v1.22 or greater (is currently used for building binary)
|
||||
|
||||
### CLI Tool (Recommended)
|
||||
|
||||
It is currently required to have golang v1.22 or greater to build the provision-cli.
|
||||
On Ubuntu 24.04 you can just run `sudo apt install golang`
|
||||
The CLI tool provides a user-friendly interface for managing your environments:
|
||||
|
||||
```bash
|
||||
@@ -101,6 +107,40 @@ If you encounter issues:
|
||||
3. For Kubernetes issues, use `kubectl` commands on the control plane
|
||||
4. Ensure all prerequisites are properly installed
|
||||
5. **Note**: This project has only been tested on Ubuntu 24.04 and WSL Ubuntu 24.04. Using other operating systems may result in compatibility issues.
|
||||
6. In case you get an authentication error when running something like `multipass list`
|
||||
|
||||
```
|
||||
list failed: The client is not authenticated with the Multipass service.
|
||||
Please use 'multipass authenticate' before proceeding.
|
||||
```
|
||||
|
||||
`multipass authenticate`
|
||||
|
||||
```
|
||||
Please enter passphrase:
|
||||
authenticate failed: Passphrase is not set. Please `multipass set
|
||||
local.passphrase` with a trusted client.
|
||||
```
|
||||
`multipass set local.passphrase`
|
||||
|
||||
```
|
||||
Please enter passphrase:
|
||||
Please re-enter passphrase:
|
||||
set failed: The client is not authenticated with the Multipass service.
|
||||
Please use 'multipass authenticate' before proceeding.
|
||||
```
|
||||
|
||||
This may not even work when using sudo.
|
||||
|
||||
The following workaround should help get out of this situation:
|
||||
|
||||
```
|
||||
cat ~/snap/multipass/current/data/multipass-client-certificate/multipass_cert.pem | sudo tee -a /var/snap/multipass/common/data/multipassd/authenticated-certs/multipass_client_certs.pem > /dev/null
|
||||
snap restart multipass
|
||||
```
|
||||
You may need sudo with this last command: `sudo snap restart multipass.`
|
||||
|
||||
At this point, your client should be authenticated with the Multipass service.
|
||||
|
||||
## Contributing
|
||||
|
||||
|
||||
Reference in New Issue
Block a user