-
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.
add fe-docs-1.70.0-c82e3b5fae79bc6ab23683eab191e84a762f59b0.tgz
fe-docs-1.70.0-c82e3b5fae79bc6ab23683eab191e84a762f59b0.tgz-meta/README.md fe-docs-1.70.0-c82e3b5fae79bc6ab23683eab191e84a762f59b0.tgz-meta/main.yaml fe-docs-1.70.0-c82e3b5fae79bc6ab23683eab191e84a762f59b0.tgz-meta/values.schema.json
- Loading branch information
1 parent
113a4be
commit 6101f60
Showing
5 changed files
with
255 additions
and
1 deletion.
There are no files selected for viewing
Binary file not shown.
135 changes: 135 additions & 0 deletions
135
fe-docs-1.70.0-c82e3b5fae79bc6ab23683eab191e84a762f59b0.tgz-meta/README.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,135 @@ | ||
| [](https://dl.circleci.com/status-badge/redirect/gh/giantswarm/happa/tree/main) | ||
| [](https://github.com/prettier/prettier) | ||
|
|
||
| # Happa | ||
|
|
||
| The Giant Swarm web user interface. It lets users: | ||
|
|
||
| - View and manage clusters | ||
| - Install and manage applications from an app catalog | ||
| - Manage their account | ||
| - Add / remove organizations | ||
| - Add / remove members from organizations | ||
| - Learn how to get started with their kubernetes clusters by following a guide | ||
|
|
||
| Happa is intended to be deployed to Giant Swarm management clusters and acts as a client to the Giant Swarm API. | ||
|
|
||
|  | ||
|
|
||
| Happa is a single page JavaScript application using React+Redux and runs in modern browsers. | ||
|
|
||
| ## Getting started with development | ||
|
|
||
| ### Prerequisites | ||
|
|
||
| To run happa locally, you need: | ||
|
|
||
| - [NodeJS 20](https://nodejs.org/) | ||
| - [`yarn`](https://yarnpkg.com/) | ||
| - [`kubectl`](https://github.com/giantswarm/kubectl) - Necessary to use happa against a Giant Swarm installation. | ||
|
|
||
| ### Quick start | ||
|
|
||
| Install dependencies: | ||
|
|
||
| ```nohighlight | ||
| yarn install | ||
| ``` | ||
|
|
||
| Some warnings regarding unmatched dependency versions are expected and can be ignored. | ||
|
|
||
| Then, to bring up Happa connected to an installation, you need to have a `kubectl` context that points to the installation's management cluster. You also need to have `get` permissions for the `happa-configmap` `ConfigMap`, in the `giantswarm` namespace. | ||
|
|
||
| You can log into the installation's management cluster using the [kubectl gs](https://github.com/giantswarm/kubectl-gs) plugin. Here's how you would start Happa after using the plugin to log into the `gauss` installation: | ||
|
|
||
| ```nohighlight | ||
| HAPPA_KUBECTL_CONTEXT=gs-gauss yarn start | ||
| ``` | ||
|
|
||
| ### Running tests | ||
|
|
||
| Execute the test suite using | ||
|
|
||
| ```nohighlight | ||
| yarn test | ||
| ``` | ||
|
|
||
| ## Releasing | ||
|
|
||
| Tagged releases are continuously deployed to all installations, both test and production. | ||
| For details see [Release.md](docs/Release.md) | ||
|
|
||
| ## User interface components | ||
|
|
||
| We are maintaining a [Storybook](https://fe-docs.giantswarm.io/) showcasing more and more of our UI components. | ||
|
|
||
| ## Configuration | ||
|
|
||
| Use environment variables or a configuration file to adjust the behaviour of the application in production. | ||
|
|
||
| These configuration values affect the config object in `index.html` (which is | ||
| created from `index.ejs`). | ||
| A configuration script (`prepare.ts`) applies the values from the configuration values | ||
| to `index.html` by templating `index.ejs` and creating the `index.html` file. This way Happa remains a fully static website | ||
| that can be served by `nginx`. | ||
|
|
||
| In development, these configuration values are applied using the `ConfigurationPlugin` via `webpack`, which generates index.html. | ||
|
|
||
| ## Redux in a nutshell | ||
|
|
||
| ``` | ||
| ╔═════════╗ ╔══════════╗ ╔═══════════╗ ╔═════════════════╗ | ||
| ║ Actions ║──────>║ Reducers ║──────>║ Store ║──────>║ View Components ║ | ||
| ╚═════════╝ ╚══════════╝ ╚═══════════╝ ╚═════════════════╝ | ||
| ^ │ | ||
| └───────────────────────────────────────────────────────────┘ | ||
| ``` | ||
|
|
||
| Components should only emit actions. | ||
|
|
||
| Reducers listen for actions and emit a new state. | ||
|
|
||
| The view listens for changes to the state and renders. | ||
|
|
||
| By following these guidelines we should get some benefits in keeping component | ||
| logic focused on rendering, and not on doing the actual work of manipulating | ||
| state. | ||
|
|
||
| ## Icons | ||
|
|
||
| Happa uses a custom icon pack which we can manage at https://fortawesome.com | ||
| Login details are in keypass, search for 'fortawesome'. | ||
| The line | ||
|
|
||
| ```html | ||
| <script src="https://use.fonticons.com/d940f7eb.js"></script> | ||
| ``` | ||
|
|
||
| in `src/index.ejs` is what includes the fonts for us. | ||
|
|
||
| More information about our font kit and how to use it can be found here: | ||
| https://fortawesome.com/kits/d940f7eb/docs | ||
|
|
||
| ## Updating dependencies | ||
|
|
||
| Renovate is configured for this repository to automatically create pull requests (PRs) that update our dependencies and to request reviews from the relevant teams/individuals. Reviewers can be configured in the `CODEOWNERS` file, and more information regarding Renovate configurations can be found [here](https://intranet.giantswarm.io/docs/dev-and-releng/ci/tools/renovate/). | ||
|
|
||
| ## Coding style | ||
|
|
||
| Happa's code style is determined by `prettier`. There is a pre-commit hook enforcing that | ||
| the coding style rules are met. A CI step will also avoid building any code that does not | ||
| match expectations, which then surfaces in the pull request checks in Github. | ||
|
|
||
| You can run `prettier` on the whole codebase using `yarn prettier`. | ||
|
|
||
| We use the following config params: | ||
|
|
||
| - `--jsx-single-quote` | ||
| - `--single-quote` | ||
| - `--trailing-comma es5` | ||
|
|
||
| ## Pre-commit hooks | ||
|
|
||
| To avoid pushing code that will fail the CI due to codestyle issues, we've added a pre-commit hook using [`husky`](https://github.com/typicode/husky/). | ||
|
|
||
| This runs before every commit, and it will not let commits go through if the `tsc`, `eslint`, or `prettier` checks have not passed. |
11 changes: 11 additions & 0 deletions
11
fe-docs-1.70.0-c82e3b5fae79bc6ab23683eab191e84a762f59b0.tgz-meta/main.yaml
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,11 @@ | ||
| annotations: | ||
| application.giantswarm.io/metadata: https://giantswarm.github.io/giantswarm-operations-platform-test-catalog/fe-docs-1.70.0-c82e3b5fae79bc6ab23683eab191e84a762f59b0.tgz-meta/main.yaml | ||
| application.giantswarm.io/readme: https://giantswarm.github.io/giantswarm-operations-platform-test-catalog/fe-docs-1.70.0-c82e3b5fae79bc6ab23683eab191e84a762f59b0.tgz-meta/README.md | ||
| application.giantswarm.io/team: honeybadger | ||
| application.giantswarm.io/values-schema: https://giantswarm.github.io/giantswarm-operations-platform-test-catalog/fe-docs-1.70.0-c82e3b5fae79bc6ab23683eab191e84a762f59b0.tgz-meta/values.schema.json | ||
| chartApiVersion: v1 | ||
| chartFile: fe-docs-1.70.0-c82e3b5fae79bc6ab23683eab191e84a762f59b0.tgz | ||
| dateCreated: '2024-12-17T12:21:10.846335Z' | ||
| digest: c444f61d5fb7e0e5d979888c3014cdd6d2d4667026825cf4f0938dcab5f1c3a0 | ||
| home: https://github.com/giantswarm/happa | ||
| icon: https://s.giantswarm.io/app-icons/giantswarm/1/light.svg |
92 changes: 92 additions & 0 deletions
92
fe-docs-1.70.0-c82e3b5fae79bc6ab23683eab191e84a762f59b0.tgz-meta/values.schema.json
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,92 @@ | ||
| { | ||
| "$schema": "http://json-schema.org/schema#", | ||
| "type": "object", | ||
| "properties": { | ||
| "containerSecurityContext": { | ||
| "type": "object", | ||
| "properties": { | ||
| "allowPrivilegeEscalation": { | ||
| "type": "boolean" | ||
| }, | ||
| "capabilities": { | ||
| "type": "object", | ||
| "properties": { | ||
| "drop": { | ||
| "type": "array" | ||
| } | ||
| } | ||
| }, | ||
| "runAsNonRoot": { | ||
| "type": "boolean" | ||
| }, | ||
| "podSeccompProfile": { | ||
| "type": "object", | ||
| "properties": { | ||
| "type": { | ||
| "type": "string" | ||
| } | ||
| } | ||
| } | ||
| } | ||
| }, | ||
| "groupID": { | ||
| "type": "integer" | ||
| }, | ||
| "hostnames": { | ||
| "type": "array" | ||
| }, | ||
| "image": { | ||
| "type": "object", | ||
| "properties": { | ||
| "name": { | ||
| "type": "string" | ||
| }, | ||
| "repository": { | ||
| "type": "string" | ||
| }, | ||
| "sha": { | ||
| "type": "string" | ||
| }, | ||
| "tag": { | ||
| "type": "string" | ||
| } | ||
| } | ||
| }, | ||
| "name": { | ||
| "type": "string" | ||
| }, | ||
| "namespace": { | ||
| "type": "string" | ||
| }, | ||
| "port": { | ||
| "type": "integer" | ||
| }, | ||
| "registry": { | ||
| "type": "object", | ||
| "properties": { | ||
| "domain": { | ||
| "type": "string" | ||
| } | ||
| } | ||
| }, | ||
| "userID": { | ||
| "type": "integer" | ||
| }, | ||
| "podSeccompProfile": { | ||
| "type": "object", | ||
| "properties": { | ||
| "type": { | ||
| "type": "string" | ||
| } | ||
| } | ||
| }, | ||
| "podSecurityStandards": { | ||
| "type": "object", | ||
| "properties": { | ||
| "enforced": { | ||
| "type": "boolean" | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } |
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