-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
task(mkdocs): deploy mkdocs (part 3)
- Loading branch information
Showing
5 changed files
with
53 additions
and
44 deletions.
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,29 @@ | ||
# Google Cloud Integration | ||
|
||
This page contains information on how to configure the application to use resources on Google Cloud. | ||
Use-cases: | ||
|
||
- Install private dependencies published on [Artifact Registry](https://cloud.google.com/artifact-registry). | ||
- Publish docker image on [Artifact Registry](https://cloud.google.com/artifact-registry). | ||
- Deploy to [Google Kubernetes Engine (GKE)](https://cloud.google.com/kubernetes-engine). | ||
- Deploy to [Cloud Run](https://cloud.google.com/run). | ||
|
||
## Install GCloud CLI | ||
|
||
- Install it from the [GCloud Installation](https://cloud.google.com/sdk/docs/install) page. | ||
- Run in terminal: | ||
|
||
```shell | ||
gcloud init | ||
``` | ||
|
||
- You will be asked to sign via Google Sign On. | ||
- Choose your project option from the menu. | ||
|
||
## Install G-Cloud implementation of keyring in Poetry | ||
|
||
1. Run in terminal: | ||
|
||
```sh | ||
poetry self add keyrings.google-artifactregistry-auth | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,3 @@ | ||
# fastapi-k8s | ||
|
||
[FastAPI](https://fastapi.tiangolo.com/) app for Kubernetes. | ||
|
||
- [Setup](SETUP.md) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
# Setup | ||
|
||
This page contain information on how to set up the project locally. | ||
|
||
## Install Poetry | ||
|
||
- Install it from the [Poetry Installation](https://python-poetry.org/docs/#installation) page. | ||
- Check the installation by running: | ||
|
||
```shell | ||
poetry --version | ||
``` | ||
|
||
- Make sure your version is **1.2.2 or higher.** | ||
|
||
### Install Dependencies via Poetry | ||
|
||
1. Run in terminal: | ||
|
||
```sh | ||
poetry install | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,6 +1,6 @@ | ||
site_name: FastAPI on Kubernetes | ||
site_url: https://svaponi.github.io/fastapi-k8s | ||
nav: | ||
- Home: INDEX.md | ||
- Setup: SETUP.md | ||
- Home: index.md | ||
- Setup: setup.md | ||
theme: readthedocs |