before code-editor refactoring

Author: Yuriy Bezsonov

.kiro/specs/arm64-code-editor-support/design.md

@@ -0,0 +1,110 @@
+# Requirements Document
+
+## Introduction
+
+This feature adds ARM64 (Graviton) architecture support to the workshop IDE infrastructure, introduces AWS Code Editor as an alternative to code-server, enhances the extension installation with a comprehensive set for Java workshops, adds Kiro CLI installation, and implements token-based URL access for Workshop Studio integration.
+
+## Glossary
+
+- **ARM64/Graviton**: AWS's ARM-based processors offering better price-performance for many workloads
+- **Code Editor**: AWS's VS Code-based IDE for Workshop Studio
+- **code-server**: Open-source VS Code server implementation currently used
+- **Kiro CLI**: AWS's AI-powered CLI tool for development assistance
+- **Workshop Studio**: AWS's platform for hosting interactive workshops
+- **Architecture Parameter**: CDK construct parameter that determines whether to use ARM64 or x86_64 instances and binaries
+
+## Requirements
+
+### Requirement 1: Architecture Parameter in CDK
+
+**User Story:** As a workshop administrator, I want to specify the architecture (ARM64 or x86_64) as a CDK parameter, so that instance types and script behavior are automatically derived from this single setting.
+
+#### Acceptance Criteria
+
+1. WHEN the Ide construct is instantiated THEN the System SHALL accept an architecture parameter (ARM64 or X86_64)
+2. WHEN architecture is set to ARM64 THEN the System SHALL use Graviton instance types (m7g, m6g families)
+3. WHEN architecture is set to X86_64 THEN the System SHALL use Intel/AMD instance types (m7i-flex, m6i, m5 families)
+4. WHEN architecture is set THEN the System SHALL pass the architecture value to UserData for script consumption
+5. WHEN architecture parameter is not specified THEN the System SHALL default to ARM64
+
+### Requirement 2: Architecture-Aware Script Downloads
+
+**User Story:** As a workshop administrator, I want the IDE scripts to use the architecture from CDK parameter, so that the correct binary versions are downloaded.
+
+#### Acceptance Criteria
+
+1. WHEN the bootstrap scripts execute THEN the System SHALL read the architecture from environment variable set by UserData
+2. WHEN downloading kubectl THEN the System SHALL use the architecture-appropriate binary URL (arm64 or amd64)
+3. WHEN downloading SAM CLI THEN the System SHALL use the architecture-appropriate zip file (arm64 or x86_64)
+4. WHEN downloading eks-node-viewer THEN the System SHALL use the architecture-appropriate binary (arm64 or x86_64)
+5. WHEN downloading SOCI snapshotter THEN the System SHALL use the architecture-appropriate tarball (arm64 or amd64)
+6. WHEN downloading yq THEN the System SHALL use the architecture-appropriate binary (arm64 or amd64)
+7. WHEN downloading Helm THEN the System SHALL use the architecture-appropriate installation
+
+### Requirement 3: AWS Code Editor Installation
+
+**User Story:** As a workshop administrator, I want to install AWS Code Editor alongside code-server, so that I can choose the best IDE option for Workshop Studio integration.
+
+#### Acceptance Criteria
+
+1. WHEN the code-editor.sh script executes THEN the System SHALL download AWS Code Editor from code-editor.amazonaws.com
+2. WHEN downloading AWS Code Editor THEN the System SHALL verify the SHA256 checksum against the manifest
+3. WHEN installing AWS Code Editor THEN the System SHALL install to the user's ~/.local directory
+4. WHEN configuring AWS Code Editor THEN the System SHALL create a systemd service on port 8889 (same as code-server)
+5. WHEN configuring AWS Code Editor THEN the System SHALL accept the server license terms automatically
+6. WHEN the code-editor.sh script completes THEN the System SHALL configure Caddy to proxy port 8889
+
+### Requirement 4: Extension Installation Enhancement
+
+**User Story:** As a workshop participant, I want the IDE to have all necessary extensions pre-installed, so that I can start coding immediately without manual setup.
+
+#### Acceptance Criteria
+
+1. WHEN installing extensions THEN the System SHALL install AWS Toolkit extension (AmazonWebServices.aws-toolkit-vscode)
+2. WHEN installing extensions THEN the System SHALL install Java Extension Pack (vscjava.vscode-java-pack)
+3. WHEN installing extensions THEN the System SHALL install Docker extension (ms-azuretools.vscode-docker)
+4. WHEN installing extensions THEN the System SHALL install Kubernetes extension (ms-kubernetes-tools.vscode-kubernetes-tools)
+5. WHEN installing extensions THEN the System SHALL install Prettier extension (esbenp.prettier-vscode)
+6. WHEN installing extensions THEN the System SHALL install Trailing Spaces extension (shardulm94.trailing-spaces)
+7. WHEN extension installation fails THEN the System SHALL log the failure and continue with remaining extensions
+
+### Requirement 5: Kiro CLI Installation
+
+**User Story:** As a workshop participant, I want Kiro CLI pre-installed, so that I can use AI-assisted development features.
+
+#### Acceptance Criteria
+
+1. WHEN the bootstrap scripts execute THEN the System SHALL download and install Kiro CLI
+2. WHEN Kiro CLI installation completes THEN the System SHALL verify the installation by checking the version
+3. IF Kiro CLI installation fails THEN the System SHALL log the error and continue bootstrap
+
+### Requirement 6: Token-Based URL Access
+
+**User Story:** As a workshop administrator, I want the IDE URL to include an authentication token, so that Workshop Studio can provide seamless access.
+
+#### Acceptance Criteria
+
+1. WHEN AWS Code Editor is configured THEN the System SHALL create a token file at ~/.code-editor-server/data/token
+2. WHEN the CloudFormation stack outputs the URL THEN the System SHALL include the token parameter (?tkn=xxx)
+3. WHEN a user accesses the URL with valid token THEN the System SHALL authenticate automatically
+
+### Requirement 7: CDK Instance Type Lists
+
+**User Story:** As a workshop administrator, I want the CDK to have predefined instance type lists for each architecture, so that the correct instances are used based on the architecture parameter.
+
+#### Acceptance Criteria
+
+1. WHEN architecture is ARM64 THEN the System SHALL use instance types from the ARM64 list (m7g.xlarge, m6g.xlarge, t4g.xlarge)
+2. WHEN architecture is X86_64 THEN the System SHALL use instance types from the x86_64 list (m7i-flex.xlarge, m6i.xlarge, m5.xlarge, t3.xlarge)
+3. WHEN the CDK code is updated THEN the System SHALL preserve the old instance list as comments for reference
+4. WHEN instance launch fails THEN the System SHALL try the next instance type in the architecture-specific list
+
+### Requirement 8: Shared Extension Installation Logic
+
+**User Story:** As a maintainer, I want extension installation logic to be reusable, so that both code-server and AWS Code Editor can use the same code.
+
+#### Acceptance Criteria
+
+1. WHEN installing extensions THEN the System SHALL use a shared function that accepts the IDE binary path as parameter
+2. WHEN the shared function is called THEN the System SHALL use retry logic for resilience
+3. WHEN the shared function is called THEN the System SHALL support both code-server and code-editor-server binaries

.kiro/specs/arm64-code-editor-support/requirements.md

@@ -0,0 +1,163 @@
+# Implementation Plan
+
+- [ ] 1. Add IdeArch and IdeType support to CDK Ide construct
+  - [ ] 1.1 Create IdeArch enum in Ide.java
+    - Add enum with ARM64 and X86_64 values
+    - Include helper methods for AWS and uname values
+    - _Requirements: 1.1_
+  - [ ] 1.2 Create IdeType enum in Ide.java
+    - Add enum with CODE_EDITOR and VSCODE values
+    - Include scriptName helper method
+    - _Requirements: 3.1_
+  - [ ] 1.3 Add ideArch and ideType properties to IdeProps
+    - Add ideArch field with ARM64 default
+    - Add ideType field with CODE_EDITOR default
+    - Create static instance type lists for each architecture
+    - Update getInstanceTypes() to return ideArch-specific list
+    - Update getMachineImage() to return ideArch-specific AMI
+    - Add builder methods for ideArch and ideType
+    - Comment out old instance type list for reference
+    - _Requirements: 1.2, 1.3, 1.5, 7.1, 7.2_
+  - [ ] 1.4 Update UserData to export ARCH and IDE_TYPE
+    - Modify userdata.sh template to include ARCH and IDE_TYPE exports
+    - Pass ideArch and ideType values from CDK to UserData
+    - _Requirements: 1.4, 2.1_
+  - [ ] 1.5 Write property test for ideArch → instance types mapping
+    - **Property 1: Architecture determines instance types**
+    - **Validates: Requirements 1.2, 1.3, 7.1, 7.2**
+
+- [ ] 2. Add architecture detection to base.sh
+  - [ ] 2.1 Add architecture detection and normalization
+    - Read ARCH from environment or detect via uname
+    - Create ARCH_K8S, ARCH_SAM, ARCH_GENERIC, ARCH_YQ variables
+    - _Requirements: 2.1_
+  - [ ] 2.2 Update kubectl download URL
+    - Use ARCH_K8S variable in download URL
+    - _Requirements: 2.2_
+  - [ ] 2.3 Update SAM CLI download URL
+    - Use ARCH_SAM variable in download URL
+    - _Requirements: 2.3_
+  - [ ] 2.4 Update eks-node-viewer download URL
+    - Use ARCH_GENERIC variable in download URL
+    - _Requirements: 2.4_
+  - [ ] 2.5 Update SOCI snapshotter download URL
+    - Use ARCH_K8S variable (amd64/arm64) in download URL
+    - _Requirements: 2.5_
+  - [ ] 2.6 Update yq download URL
+    - Use ARCH_YQ variable in download URL
+    - _Requirements: 2.6_
+  - [ ] 2.7 Update Java path for ARM64
+    - Handle different Java paths for aarch64 vs x86_64
+    - _Requirements: 2.1_
+
+- [ ] 3. Checkpoint - Verify architecture detection works
+  - Ensure all tests pass, ask the user if questions arise.
+
+- [ ] 4. Create ide-settings.sh with common IDE configuration
+  - [ ] 4.1 Create ide-settings.sh file
+    - Define EXTENSIONS variable with full list
+    - Define DEFAULT_WORKSPACE variable
+    - _Requirements: 4.1-4.6_
+  - [ ] 4.2 Add install_ide_extensions function
+    - Accept binary command and user as parameters
+    - Loop through extensions with retry logic
+    - _Requirements: 4.7, 8.1, 8.2, 8.3_
+  - [ ] 4.3 Add configure_default_workspace function
+    - Accept coder.json path and user as parameters
+    - Create workspace config if not exists
+    - _Requirements: 4.1_
+
+- [ ] 5. Create code-editor.sh for AWS Code Editor
+  - [ ] 5.1 Add code-editor installation function
+    - Download manifest from code-editor.amazonaws.com
+    - Support ARM64 and x64 architectures
+    - _Requirements: 3.1_
+  - [ ] 5.2 Add checksum verification
+    - Verify SHA256 checksum against manifest
+    - Fail with clear error on mismatch
+    - _Requirements: 3.2_
+  - [ ] 5.3 Add installation to user's .local directory
+    - Extract to ~/.local/lib/code-editor-VERSION/
+    - Create symlink in ~/.local/bin/
+    - _Requirements: 3.3_
+  - [ ] 5.4 Add systemd service configuration
+    - Create code-editor@.service unit file
+    - Configure for port 8889
+    - Accept server license terms
+    - _Requirements: 3.4, 3.5_
+  - [ ] 5.5 Add token authentication setup
+    - Create ~/.code-editor-server/data/token file
+    - Write IDE_PASSWORD to token file
+    - _Requirements: 6.1_
+  - [ ] 5.6 Add Caddy proxy configuration
+    - Configure Caddy to proxy port 8889
+    - Same config as vscode.sh
+    - _Requirements: 3.6_
+  - [ ] 5.7 Source ide-settings.sh and call shared functions
+    - Call install_ide_extensions with code-editor-server
+    - Call configure_default_workspace
+    - _Requirements: 4.1-4.7_
+
+- [ ] 6. Update vscode.sh to use shared settings
+  - [ ] 6.1 Source ide-settings.sh
+    - Remove inline EXTENSIONS variable
+    - Source ide-settings.sh at top of file
+    - _Requirements: 4.1-4.6_
+  - [ ] 6.2 Use install_ide_extensions function
+    - Replace inline extension loop with function call
+    - Pass "code-server" and "ec2-user"
+    - _Requirements: 4.7_
+  - [ ] 6.3 Use configure_default_workspace function
+    - Replace inline coder.json creation with function call
+    - _Requirements: 4.1_
+
+- [ ] 7. Update bootstrap.sh for IDE selection
+  - [ ] 7.1 Read IDE_TYPE from environment
+    - Use IDE_TYPE from UserData (set by CDK)
+    - Default to "code-editor" if not set
+    - _Requirements: 3.1_
+  - [ ] 7.2 Add dynamic code alias to workshop.sh
+    - Set alias based on IDE_TYPE
+    - code-editor: /home/ec2-user/.local/bin/code-editor-server
+    - vscode: code-server
+    - _Requirements: 3.4_
+  - [ ] 7.3 Update IDE setup call
+    - Change from hardcoded vscode.sh to ${IDE_TYPE}.sh
+    - _Requirements: 3.1_
+
+- [ ] 8. Update shell.sh for both IDEs
+  - [ ] 8.1 Update .zshrc code alias
+    - Add dynamic alias that detects installed IDE
+    - Check for code-editor-server first, then code-server
+    - _Requirements: 3.4_
+  - [ ] 8.2 Update settings.json zsh configuration
+    - Check both code-server and code-editor settings.json paths
+    - Update whichever exists
+    - _Requirements: 3.4_
+
+- [ ] 9. Add Kiro CLI installation to base.sh
+  - [ ] 9.1 Add install_kiro_cli function
+    - Download and run Kiro CLI installer
+    - Use retry_optional for resilience
+    - _Requirements: 5.1_
+  - [ ] 9.2 Add version verification
+    - Check kiro-cli --version after install
+    - Log warning if verification fails
+    - _Requirements: 5.2, 5.3_
+  - [ ] 9.3 Call install_kiro_cli in base.sh
+    - Add to end of base.sh before shell setup
+    - _Requirements: 5.1_
+
+- [ ] 10. Checkpoint - Test full bootstrap
+  - Ensure all tests pass, ask the user if questions arise.
+
+- [ ] 11. Update CDK URL output for conditional token-based access
+  - [ ] 11.1 Modify Ide.java URL output based on IdeType
+    - For CODE_EDITOR: Include ?folder= and ?tkn= parameters
+    - Format: https://domain/?folder=/home/ec2-user/environment&tkn=PASSWORD
+    - For VSCODE: Standard URL without token (password via login page)
+    - Format: https://domain/
+    - _Requirements: 6.2, 6.3_
+
+- [ ] 12. Final Checkpoint - Verify complete setup
+  - Ensure all tests pass, ask the user if questions arise.