-
Notifications
You must be signed in to change notification settings - Fork 1
feat: update projectEnv doc #122
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,73 @@ | ||
| --- | ||
| sidebar_label: Dependency Access Configuration | ||
| sidebar_position: 7 | ||
| --- | ||
|
|
||
| import Zoom from "react-medium-image-zoom"; | ||
| import "react-medium-image-zoom/dist/styles.css"; | ||
|
|
||
| # Access Configuration | ||
|
|
||
| The Access Configuration allows you to extend your project's permissions by granting access to external dependencies from other projects and attaching additional IAM policies. This feature enables cross-project resource sharing and enhanced security configurations. | ||
|
|
||
| ## Configuration Steps | ||
|
|
||
| 1. Navigate to **Project** → **Settings** | ||
| 2. Select **Access Configuration** from the settings menu | ||
| 3. Configure external dependencies and extra policies as needed | ||
| 4. Click **Apply changes** to save your configuration | ||
|
|
||
| <Zoom overlayBgColorEnd="rgba(255, 255, 255, 0.8)"> | ||
| <img | ||
| src="/img/project/access-config.png" | ||
| alt="access config" | ||
| /> | ||
| </Zoom> | ||
|
|
||
| ## External Dependencies | ||
|
|
||
| ### Dependencies Already Assigned | ||
|
|
||
| This section shows dependencies that have already been linked to your current project. These dependencies are available for your workloads to use and are marked with a blue checkbox to indicate they are active. | ||
|
|
||
| **Features:** | ||
| - View all currently assigned external dependencies | ||
| - See dependency type and project information | ||
| - Dependencies are automatically configured with appropriate permissions | ||
|
|
||
| ### Available External Dependencies | ||
|
|
||
| This section displays dependencies from other projects that you can grant access to your current project. This enables cross-project resource sharing and collaboration. | ||
|
|
||
| **How it works:** | ||
| - Select dependencies from other projects that you wish to grant access to this project | ||
| - Only dependencies from projects you have access to will be displayed | ||
| - Once selected, the dependency becomes available in the "Dependencies Already Assigned" section | ||
|
|
||
| ## Extra Policies | ||
|
|
||
| The Extra Policies section allows you to attach additional IAM policies to your project, providing enhanced permissions beyond the default project access. | ||
|
|
||
| ### Adding Extra Policies | ||
|
|
||
| 1. Click the **"Attach more policies"** button | ||
| 2. Select from available IAM policies in your AWS account | ||
| 3. Review the policy permissions before attaching | ||
| 4. The policies will be applied to grant additional permissions to the project | ||
|
|
||
| ### Policy Management | ||
|
|
||
| - **Custom Policies**: Attach policies you've created in your AWS IAM console | ||
| - **AWS Managed Policies**: Use pre-configured AWS policies for common use cases | ||
| - **Policy Review**: All attached policies are listed and can be reviewed | ||
| - **Removal**: Policies can be detached if no longer needed | ||
|
|
||
| :::tip Cross-Project Access | ||
| External dependencies enable teams to share resources across different projects, improving collaboration and resource utilization. | ||
| ::: | ||
|
|
||
| :::warning Security Considerations | ||
| - Review all attached policies to ensure they follow the principle of least privilege | ||
| - Regularly audit external dependencies to ensure they're still needed | ||
| - Monitor access patterns to identify any unusual activity | ||
| ::: |
| Original file line number | Diff line number | Diff line change | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| @@ -0,0 +1,51 @@ | ||||||||||||||
| --- | ||||||||||||||
| sidebar_label: Deploy Build Resources | ||||||||||||||
| sidebar_position: 6 | ||||||||||||||
| --- | ||||||||||||||
|
|
||||||||||||||
| import Zoom from "react-medium-image-zoom"; | ||||||||||||||
| import "react-medium-image-zoom/dist/styles.css"; | ||||||||||||||
|
|
||||||||||||||
| # Deploy Build Resources | ||||||||||||||
|
|
||||||||||||||
| The Deploy Build Resources configuration allows you to specify the CPU and memory resource requests for both build and deployment processes. This helps ensure that your builds and deployments have sufficient resources to complete successfully while optimizing costs. | ||||||||||||||
|
|
||||||||||||||
| ## Resource Configuration | ||||||||||||||
|
|
||||||||||||||
| <Zoom overlayBgColorEnd="rgba(255, 255, 255, 0.8)"> | ||||||||||||||
| <img | ||||||||||||||
| src="/img/project/build-deploy-resources.png" | ||||||||||||||
| alt="dockerfile settings page" | ||||||||||||||
| /> | ||||||||||||||
| </Zoom> | ||||||||||||||
|
|
||||||||||||||
| Access the Deploy Build Resources settings: | ||||||||||||||
|
|
||||||||||||||
| 1. Navigate to **Project** → **Settings** | ||||||||||||||
| 2. Select **Deploy Build Resources** from the settings menu | ||||||||||||||
| 3. Configure the resource values according to your project's requirements | ||||||||||||||
| 4. Click **Save** to apply the changes | ||||||||||||||
|
|
||||||||||||||
| ### Build Request Resources | ||||||||||||||
|
|
||||||||||||||
| Configure the resources allocated during the build process: | ||||||||||||||
|
|
||||||||||||||
| - **Build Request CPU**: Specifies the CPU allocation for build processes (measured in millicores) | ||||||||||||||
| - **Build Request Memory**: Specifies the memory allocation for build processes (measured in GiB) | ||||||||||||||
|
|
||||||||||||||
| ### Deploy Request Resources | ||||||||||||||
|
|
||||||||||||||
| Configure the resources allocated during the deployment process: | ||||||||||||||
|
|
||||||||||||||
| - **Deploy Request CPU**: Specifies the CPU allocation for deployment processes (measured in millicores) | ||||||||||||||
| - **Deploy Request Memory**: Specifies the memory allocation for deployment processes (measured in GiB) | ||||||||||||||
|
|
||||||||||||||
| :::tip Resource Optimization | ||||||||||||||
| - Start with default values and adjust based on build performance | ||||||||||||||
| - Monitor build times and resource usage to optimize allocations | ||||||||||||||
| - Higher resource allocations can reduce build times but increase costs | ||||||||||||||
| ::: | ||||||||||||||
|
|
||||||||||||||
| :::warning Resource Limits | ||||||||||||||
| - Ensure your cluster has sufficient resources to accommodate the requested allocations | ||||||||||||||
| ::: | ||||||||||||||
|
Comment on lines
+49
to
+51
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Hay un espacio en blanco al final de la línea 51. Limpiá el espacio trailing después de ":::" en la línea 51. :::warning Resource Limits
- Ensure your cluster has sufficient resources to accommodate the requested allocations
-:::
+:::📝 Committable suggestion
Suggested change
🤖 Prompt for AI Agents
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. ! There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. @lucaiz ¡Dale, mandale nomás! Eliminá ese espacio trailing y dejalo limpio. 💪 |
||||||||||||||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -26,6 +26,15 @@ Cada empresa puede tener solo una API_KEY activa a la vez. Si solicitas una nuev | |
|
|
||
| Una vez que tengas tu API_KEY, puedes usarla como argumento al ejecutar comandos de SleakOps o configurarla como una variable de entorno llamada SLEAKOPS_KEY. | ||
|
|
||
| :::tip Configurando SLEAKOPS_KEY en Pipelines de CI/CD | ||
| Para pipelines de CI/CD, se recomienda configurar SLEAKOPS_KEY como una variable de entorno secreta en tu proveedor de Git: | ||
| - **GitHub**: Agrégala como un secreto de repositorio en Settings → Secrets and variables → Actions | ||
| - **GitLab**: Agrégala como una variable de CI/CD en Settings → CI/CD → Variables | ||
| - **Bitbucket**: Agrégala como una variable de repositorio en Repository settings → Pipelines → Repository variables | ||
|
|
||
| Esto asegura el acceso seguro a los servicios de SleakOps sin exponer tu clave API en los archivos de configuración de tu pipeline. | ||
| ::: | ||
|
|
||
| ### 2. Crear un Build | ||
|
|
||
| Para crear una compilación de tu aplicación, usa el siguiente comando: | ||
|
|
@@ -43,6 +52,15 @@ Como se mencionó anteriormente, la clave puede ser un entrada aquí o una varia | |
|
|
||
| También puedes indicar si quieres que el proceso **espere** a que la compilación termine o no. | ||
|
|
||
| :::tip DockerArgs desde CLI | ||
| También puedes definir DockerArgs cuando uses la CLI de SleakOps para builds. Usa el parámetro `--docker-args` para pasar argumentos de construcción directamente desde la línea de comandos: | ||
|
|
||
| ```bash | ||
| sleakops build -p myproject -b main --docker-args "ARG1=value1,ARG2=value2" | ||
| ``` | ||
|
|
||
| Esto es particularmente útil para pipelines de CI/CD donde quieres pasar diferentes argumentos basados en el entorno o contexto de construcción. | ||
| ::: | ||
|
Comment on lines
+55
to
+63
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🛠️ Refactor suggestion | 🟠 Major Detectada duplicación de contenido - ¡a resolver este conflicto! Este tip sobre DockerArgs es idéntico al que se encuentra en Sugerencias para resolver este conflicto a las piñas:
Aplica este diff para reemplazar la duplicación con una referencia cruzada: -:::tip DockerArgs desde CLI
-También puedes definir DockerArgs cuando uses la CLI de SleakOps para builds. Usa el parámetro `--docker-args` para pasar argumentos de construcción directamente desde la línea de comandos:
-
-```bash
-sleakops build -p myproject -b main --docker-args "ARG1=value1,ARG2=value2"
-```
-
-Esto es particularmente útil para pipelines de CI/CD donde quieres pasar diferentes argumentos basados en el entorno o contexto de construcción.
-:::
+:::tip DockerArgs desde CLI
+También puedes pasar argumentos de construcción Docker usando el parámetro `--docker-args` en la CLI. Para más detalles y ejemplos, consulta la sección de [Configuración de Dockerfile](/project/configure_your_dockerfile#cómo-agrego-los-argumentos-del-dockerfile).
+:::🤖 Prompt for AI Agents |
||
|
|
||
| ### 3. Realizar un Despliegue | ||
| Una vez que tu compilación esté lista, puedes desplegar tu aplicación fácilmente usando el siguiente comando: | ||
|
|
||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
El texto alternativo de la imagen no coincide con el contenido.
El alt text indica "dockerfile settings page" cuando la imagen muestra la configuración de recursos de build y deploy. Corregilo para mejor accesibilidad.
Aplicá este diff:
<img src="/img/project/build-deploy-resources.png" - alt="dockerfile settings page" + alt="Deploy build resources configuration" />📝 Committable suggestion
🤖 Prompt for AI Agents