Skip to content

Commit

Permalink
task(k8s): update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
svaponi committed Apr 18, 2024
1 parent f7ea0df commit efc1821
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 28 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# fastapi-k8s

[FastAPI](https://fastapi.tiangolo.com/) wrapper for Kubernetes.
[FastAPI](https://fastapi.tiangolo.com/) app for Kubernetes.
46 changes: 19 additions & 27 deletions docs/SETUP.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,44 +5,36 @@
1. Install it from the [Poetry Installation](https://python-poetry.org/docs/#installation) page.
2. Check the installation by running:

```shell
poetry --version
```
```shell
poetry --version
```

3. Make sure your version is **1.2.2 or higher.**

## Install G-Cloud CLI
## Install GCloud CLI

1. Install it from the [G-Cloud Installation](https://cloud.google.com/sdk/docs/install) page.
2. Make sure you include the CLI into your environment variables.
3. In a new terminal, initialize the CLI by running:
1. Install it from the [GCloud Installation](https://cloud.google.com/sdk/docs/install) page.
2. Run in terminal:

```shell
gcloud init
```
```shell
gcloud init
```

4. You will be asked to sign via Google Sign On.
5. Choose your project option from the menu.
3. You will be asked to sign via Google Sign On.
4. Choose your project option from the menu.

## Install G-Cloud implementation of keyring in Poetry

1. From the terminal run:
1. Run in terminal:

```sh
poetry self add keyrings.google-artifactregistry-auth
```

Wait for it to complete the installation.
```sh
poetry self add keyrings.google-artifactregistry-auth
```

### Install Dependencies via Poetry

1. From the terminal run:

```sh
poetry install
```

Wait for the installation to be completed.
1. Run in terminal:

> For more information about Poetry, refer
> to [Poetry Dependencies Installation](https://python-poetry.org/docs/basic-usage/#installing-dependencies).
```sh
poetry install
```

0 comments on commit efc1821

Please sign in to comment.