Skip to content

Commit

Permalink
Merge branch 'main' into edit/data-lineage-docs
Browse files Browse the repository at this point in the history
  • Loading branch information
flower-of-the-bridges committed Nov 27, 2024
2 parents 5f05edb + a5a9575 commit df609eb
Show file tree
Hide file tree
Showing 65 changed files with 1,517 additions and 674 deletions.
40 changes: 40 additions & 0 deletions 301redirects.json
Original file line number Diff line number Diff line change
Expand Up @@ -1807,6 +1807,46 @@
"destination": "/docs/fast_data/configuration/cast_functions",
"addedOn": "2024-10-23"
},
"/docs/marketplace/add_to_marketplace/create_your_company_marketplace": {
"destination": "/docs/software-catalog/manage-items/overview-manage-items",
"addedOn": "2024-11-19"
},
"/docs/marketplace/add_to_marketplace/add_item_by_type/add_plugin": {
"destination": "/docs/software-catalog/manage-items/mia-ctl/create/create-item-by-type/create_plugin",
"addedOn": "2024-11-19"
},
"/docs/marketplace/add_to_marketplace/add_item_by_type/add_template_or_example": {
"destination": "/docs/software-catalog/manage-items/mia-ctl/create/create-item-by-type/create_template_or_example",
"addedOn": "2024-11-19"
},
"/docs/marketplace/add_to_marketplace/add_item_by_type/add_application": {
"destination": "/docs/software-catalog/manage-items/mia-ctl/create/create-item-by-type/create_application",
"addedOn": "2024-11-19"
},
"/docs/marketplace/add_to_marketplace/add_item_by_type/add_sidecar": {
"destination": "/docs/software-catalog/manage-items/mia-ctl/create/create-item-by-type/create_sidecar",
"addedOn": "2024-11-19"
},
"/docs/marketplace/add_to_marketplace/add_item_by_type/add_custom_resource": {
"destination": "/docs/software-catalog/manage-items/mia-ctl/create/create-item-by-type/create_infrastructure_resource",
"addedOn": "2024-11-19"
},
"/docs/marketplace/add_to_marketplace/manage_marketplace_items": {
"destination": "/docs/software-catalog/manage-items/overview-manage-items",
"addedOn": "2024-11-19"
},
"/docs/marketplace/add_to_marketplace/marketplace_items_accessibility": {
"destination": "/docs/software-catalog/catalog-and-marketplace/overview-catalog-and-marketplace",
"addedOn": "2024-11-19"
},
"/docs/marketplace/add_to_marketplace/change_marketplace_item_visibility": {
"destination": "/docs/software-catalog/catalog-and-marketplace/overview-catalog-and-marketplace",
"addedOn": "2024-11-19"
},
"/docs/marketplace/add_to_marketplace/declarative_marketplace": {
"destination": "/docs/software-catalog/manage-items/declarative-approach",
"addedOn": "2024-11-19"
},
"/docs/data_catalog/data_catalog_frontend": {
"destination": "/docs/data_catalog/frontend/overview",
"addedOn": "2024-11-26"
Expand Down
12 changes: 6 additions & 6 deletions docs/cli/miactl/20_setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,13 +38,13 @@ If you have [Golang] installed with a version >= 1.13 in your system and you hav
install `miactl` like this:

```sh
go install github.com/mia-platform/miactl/cmd/miactl@v0.15.0
go install github.com/mia-platform/miactl/cmd/miactl@v0.16.0
```

Or like this if the `install` command is not available

```sh
go get -u github.com/mia-platform/miactl/cmd/miactl@0.15.0
go get -u github.com/mia-platform/miactl/cmd/miactl@0.16.0
```

#### Binary Download
Expand All @@ -53,11 +53,11 @@ You can install `miactl` with the use of `curl` or `wget` and downloading the la
choosing the correct platform and operating system:

```sh
curl -fsSL https://github.com/mia-platform/miactl/releases/download/v0.15.0/miactl-linux-amd64 -o /tmp/miactl
curl -fsSL https://github.com/mia-platform/miactl/releases/download/v0.16.0/miactl-linux-amd64 -o /tmp/miactl
```

```sh
wget -q https://github.com/mia-platform/miactl/releases/download/v0.15.0/miactl-linux-amd64 -O /tmp/miactl
wget -q https://github.com/mia-platform/miactl/releases/download/v0.16.0/miactl-linux-amd64 -O /tmp/miactl
```

After you have downloaded the file you can validate it against the checksum you can find at this [url] running the
Expand Down Expand Up @@ -85,7 +85,7 @@ sudo mv /tmp/miactl /usr/local/bin
If you want to run the cli in its environment or you want to test the cli you can use the Docker image:

```sh
docker run ghcr.io/mia-platform/miactl:v0.15.0 miactl
docker run ghcr.io/mia-platform/miactl:v0.16.0 miactl
```

### Windows
Expand Down Expand Up @@ -184,7 +184,7 @@ only via APIs.

[Homebrew]: https://brew.sh "The Missing Package Manager for macOS (or Linux)"
[Golang]: https://go.dev "Build simple, secure, scalable systems with Go"
[url]: https://github.com/mia-platform/miactl/releases/download/v0.15.0/checksums.txt "miactl checksums"
[url]: https://github.com/mia-platform/miactl/releases/download/v0.16.0/checksums.txt "miactl checksums"
[`bash-completion`]: https://github.com/scop/bash-completion "Programmable completion functions for bash"
[`oh-my-zsh`]: https://ohmyz.sh "Oh My Zsh is a delightful, open source, community-driven
framework for managing your Zsh configuration"
Expand Down
57 changes: 57 additions & 0 deletions docs/cli/miactl/30_commands.md
Original file line number Diff line number Diff line change
Expand Up @@ -441,6 +441,63 @@ Available flags for the command:
- `--context`, to specify a different context from the currently selected one
- `--company-id`, to set the ID of the desired Company

### rules

Rules command helps you manage different rules for configuration update for the whole Company or specific Projects.

:::tip
This feature is currently in closed preview and may be subject to breaking changes, reach out to your Mia-Platform referent
if you are interested in use it.
:::

#### list

List available rules for the Company or for a specific Project.

Usage:

```sh
miactl company rules list [flags]
```

Available flags for the command:

- `--company-id`, the id of the Company
- `--project-id`, the id of the Project (if provided the command will print available rules for the project,
together with the rules inherited from the Company)

#### update

Helps you update rules for a Company or for a specific Project

Usage:

```sh
miactl company rules update [flags]
```

Available flags for the command:

- `--company-id`, the id of the Company
- `--project-id`, the id of the Project (if provided the command will update the rules for the specified Project only)
- `-f`, path to the file where the rules are saved

<details>
<summary>File example</summary>

```json
[
{
"roleIds": ["developer"],
"disallowedRuleSet": [
{"ruleId": "endpoint.security.edit"}
]
}
]
```

</details>

## project

This command allows you to manage `miactl` Projects.
Expand Down
2 changes: 1 addition & 1 deletion docs/cli/miactl/40_examples.md
Original file line number Diff line number Diff line change
Expand Up @@ -133,7 +133,7 @@ Finally, you can group the commands above and run them inside a pipeline, e.g. a
# Insert that after your pipeline stages
delivery:
stage: deploy
image: ghcr.io/mia-platform/miactl:v0.15.0
image: ghcr.io/mia-platform/miactl:v0.16.0
script:
- miactl version
Expand Down
15 changes: 14 additions & 1 deletion docs/cli/miactl/changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,18 @@ All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [v0.16.0] - 2024-11-21

### Added

- `company rules list` command
- `company rules update` command

### Changed

- update go version to 1.23.2
- update text to v0.19.0

## [v0.15.0] - 2024-09-12

### Added
Expand Down Expand Up @@ -307,7 +319,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
- create cli sdk
- create cli renderer

[unreleased]: https://github.com/mia-platform/miactl/compare/v0.15.0...HEAD
[unreleased]: https://github.com/mia-platform/miactl/compare/v0.16.0...HEAD
[v0.16.0]: https://github.com/mia-platform/miactl/compare/v0.15.0...v0.16.0
[v0.15.0]: https://github.com/mia-platform/miactl/compare/v0.14.0...v0.15.0
[v0.14.0]: https://github.com/mia-platform/miactl/compare/v0.13.0...v0.14.0
[v0.13.0]: https://github.com/mia-platform/miactl/compare/v0.12.2...v0.13.0
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,8 @@ You can choose between the automatic procedure and the manual one.
### ClusterRole
Next, we must define the roles needed by the previously created service account. These are the minimal roles required by the Console to work.
Next, make sure to define the roles needed by the previously created service account.
These are the minimal roles required by the Console to work.
Here is the template to quickly define them:
Expand Down Expand Up @@ -158,9 +159,34 @@ You can choose between the automatic procedure and the manual one.
- {{NAME_OF_THE_SERVICE_ACCOUNT_USED_FOR_THE_DEPLOY}}
```
#### Monitoring custom resources from the Console
Follow these guidelines to configure the custom resources.
You need to make sure that the Console has the correct permissions
to display the information to the users.
Here is an example to show how to give the correct permissions to custom resource definitions:
```yaml
apiVersion: rbac.authorization.k8s.io/v1
kind: ClusterRole
# ...
rules:
# For each custom resource definitions we need to add:
- apiGroups:
- "<custom-resource-definitions.group>"
resources:
- "<custom-resource-definitions.names.plural>"
verbs:
- get
- list
```
After adding the necessary permissions follow this [guide](/console/design-your-projects/custom-resources/custom-resources.md) to see your custom resources in the Console.
### ClusterRoleBindings
Finally, we **must** associate the roles with the service account using the `ClusterRoleBindings` that can be created using the following template:
Finally, make sure to associate the roles with the service account using the `ClusterRoleBindings` that can be created using the following template:

```yaml
apiVersion: rbac.authorization.k8s.io/v1
Expand Down
Loading

0 comments on commit df609eb

Please sign in to comment.